models

(★ 87)

OWOX Model Canvas — visual editor for data models in the Open Knowledge Format (OKF)

  • .gitignore
  • .node-version
  • .npmrc
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • NOTICE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • render.yaml
  • SECURITY.md
  • tsconfig.base.json

# Installation Guide

1. Get the code
git clone https://github.com/OWOX/models

Downloads the entire project code from GitHub to your computer.

cd models

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm --filter @mc/okf build # web/server consume okf's built dist

Type this command into your terminal and run it.

pnpm dev:web # Vite dev server (SPA) on :5173

Starts the development/run server.

pnpm dev # BFF (tsx watch) on :3000 — proxy/serve API

Starts the development/run server.

pnpm -r test # okf + server + web (Vitest)

Type this command into your terminal and run it.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation