- Clone repo
- Run
yarn install - Run
yarn dev - Copy
cp backend/.env.example backend/.envand fill in variables - Open
http:\\localhost:3001in browser
- Annotate functions, classes, etc. using jsdoc notation
- Install jsdoc globally on your machine
npm install -g jsdoc - Output documentation in the
docsfolder:jsdoc path/to/code -d docs-rrecursively scans subfolders too, e.g. to generate for everything insidesrc:jsdoc path/to/src -r -d docs