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