SuperAwesome Permissions

  • NPM package: @superawesome/permissions

  • Github: https://github.com/SuperAwesomeLTD/permissions

Features

In lieu of a proper landing page, SuperAwesome Permissions features:

(^^ github needed to show icons ^^)

Contents

The actual generated docs are at npm run docs:serve and coming soon at SuperAwesome Permissions Documentation. Go to the left, at the CompoDocs Nav Bar.

NOTE: THESE LINKS BREAK ON GITHUB! (^^^ read above ^^^)

Note: We also have native Nestjs Guard & Decorators empowering an Orthogonal / Aspect Oriented Architecture.

Versioning

The project follows semantic versioning which effectively means a new major version x.0.0 is released for breaking changes, minor 0.x.0 for new features and patch 0.0.x for fixes.

How to develop

Code

  • Simply do an npm run test:watch to develop and test at each change.

  • 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 & *.md.spec files:

  • 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:8090 in non-watch mode.

  • With npm run docs:watch it serves docs at http://127.0.0.1:8090 in watch & serve mode.

Docs generation

All *.md.spec.ts files generate equivalent src/docs/generated/*.generated.md

Note: On watch mode it's sometimes slow to build & serve, especially initially. Just change & save the *.md.spec.ts file to trigger generation & also refresh browser if its not refreshing automatically.

result-matching ""

    No results matching ""