SuperAwesome Permissions NestJS
- npm package at
@superawesome/permissions-nestjs
Contents
The actual generated docs are at npm run docs:serve
and at SuperAwesome Permissions for NestJS Documentation (they break on github) on the left at CompoDocs Nav Bar:
Versioning
The project follows semantic versioning which effectivelly means a new major version x.0.0 is released when there are breaking changes, minor 0.x.0 when there are new features and patch 0.0.x when there are fixes.
How to develop
IMPORTANT: do npm install && npm run install-example
on project root before using!
Code
-
Simply do an npm run test:watch
to develop and test at each change.
-
With npm run dev
you watch files building library at /dist
.
-
With npm run build:ts
you get a build of the library at /dist
.
-
With npm run build
you get a full build of library & docs at /dist
.
Documentation
End user docs reside at src/docs
:
-
With npm run docs:build
it builds docs at dist/docs
once.
-
With npm run docs:serve
it serves docs at http://127.0.0.1:8091 in non-watch mode.
-
With npm run docs:watch
it serves docs at http://127.0.0.1:8091 in watch mode.