Try it locally
yarn dev starts the whole PDM on your machine with stand-ins for what it normally needs. No Docker, no Postgres to install, no ClassCAD engine.
The repository isn't public yet. Ask us for access.
You need Node 20 or newer and Yarn 1.
git clone https://github.com/awv-informatik/classcad-pdm.git
cd classcad-pdm
yarn
yarn dev
Then open http://localhost:3000.
What runs
| What | Where | Real or stand-in |
|---|---|---|
| Postgres 16 | port 5003, data in .dev/pg | from the embedded-postgres npm package |
| API | http://127.0.0.1:3333/api/v1 | real |
| Job worker | real | |
| ClassCAD | port 9194 | a mock that answers with what the real engine measured in the sample models |
| Web app | http://localhost:3000 | real |
The API, the worker and the web app reload when you change their code. Files go to .dev/storage.
Sample data
On an empty database, yarn dev writes sample data through the API, the way people and workers would: an engine with sub-assemblies, releases and an update waiting, a branch, a reservation by anna, a bracket set with some history and an obsolete revision, fasteners, an archived document, a STEP import that fails, and a flange generator with two runs.
The mock knows the sample files. Upload anything else and it makes up the measures and shows a grey box. A cut-off STEP file fails the way it would for real.
Options
yarn dev --reset # start from scratch: new database, no files
yarn dev --no-seed # no sample data
yarn dev --real # the real ClassCAD at CC_URL instead of the mock
--real reads CC_URL and CLASSCAD_RENDERER_DIR from .env (see Configuration). Starting yarn dev a second time while one is running stops right away and names the ports that are taken.
The editor
The mock can't run the editor. To edit, either start a ClassCAD engine with classcad-cli worker on port 9094, or put a CLASSCAD_WASM_KEY into .env so ClassCAD runs in the browser. The editor has the details.