Commit 274e3f54 authored by Hugo SUBTIL's avatar Hugo SUBTIL
Browse files

feat(doc): add compodoc

parent a282f917
Pipeline #14169 passed with stages
in 11 minutes and 2 seconds
......@@ -392,4 +392,7 @@ dist
# Migrations
.migrate
src/migrations/data/
\ No newline at end of file
src/migrations/data/
# Documentation generated with compodoc
documentation
\ No newline at end of file
......@@ -76,6 +76,13 @@ $ http://localhost:3000/api
$ http://localhost:8081
```
## Documentation
A documentation is generated with compodoc in addition of the existing documentation on the wiki.
```sh
npm run doc:serve
```
You can now visualize it at : `localhost:8080`
## Test
```bash
......
This diff is collapsed.
......@@ -12,6 +12,8 @@
"start:dev": "nodemon",
"start:debug": "nodemon --config nodemon-debug.json",
"start:prod": "npm run migrate:up && node dist/main",
"doc": "npx @compodoc/compodoc -p tsconfig.json -s -n 'Resin api documentation'",
"doc:serve": "npm run doc && npx compodoc -s",
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
"release": "standard-version",
"init-db": "node ./scripts/init-db.js",
......@@ -57,6 +59,7 @@
"swagger-ui-express": "^4.1.5"
},
"devDependencies": {
"@compodoc/compodoc": "^1.1.11",
"@nestjs/cli": "^7.5.1",
"@nestjs/schematics": "^7.1.3",
"@nestjs/testing": "^7.5.1",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment