tsdoc generation

ref #7 , close #8
This commit is contained in:
Philipp Dormann 2020-11-27 21:40:42 +01:00
parent d85c126c27
commit 6e0447165b
3 changed files with 11 additions and 3 deletions

3
.gitignore vendored
View File

@ -130,4 +130,5 @@ yarn.lock
package-lock.json
build
*.sqlite
*.sqlite
docs

View File

@ -25,6 +25,11 @@ Backend Server
yarn dev
```
### Generate Docs
```
yarn docs
```
### Docker w/ postgres 🐳
```bash

View File

@ -53,10 +53,12 @@
"nodemon": "^2.0.6",
"sqlite3": "^5.0.0",
"ts-node": "^9.0.0",
"typedoc": "^0.19.2",
"typescript": "^4.1.2"
},
"scripts": {
"dev": "nodemon src/app.ts",
"build": "tsc"
"build": "tsc",
"docs": "typedoc --out docs src"
}
}
}