57599b4542
Bump node v in docs workflow fix(docs): treat warnings as errors false fix(docs)Correct docs pattern in gitignore Add target branch to docs build fix(docs)Correct docs pattern in gitignore Add target branch to docs build Add target branch to docs build |
||
|---|---|---|
| .gitea/workflows | ||
| .github/workflows | ||
| .husky | ||
| packages | ||
| qwrk/docs/frontend | ||
| scripts | ||
| .gitignore | ||
| .node-version | ||
| .npmrc | ||
| build-webapp.sh | ||
| docs-readme.md | ||
| DOCUMENTATION.md | ||
| lerna.json | ||
| package.json | ||
| README.md | ||
| tsconfig.doc.json | ||
| tsdoc.json | ||
| typedoc.mjs | ||
| yarn.lock | ||
snowballtools-base
This is a yarn workspace monorepo for the dashboard.
Getting Started
Install dependencies
In the root of the project, run:
yarn
Build backend
yarn build --ignore frontend
Environment variables, running the development server, and deployment
Follow the instructions in the README.md files of the backend and frontend packages.
Documentation
This project uses TSDoc for code documentation and TypeDoc for generating API documentation.
Generating Documentation
To generate the API documentation, run:
yarn docs
This will create a docs directory with the generated documentation.
For more information about writing documentation, see DOCUMENTATION.md.