Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.04 KB

Developers.md

File metadata and controls

49 lines (32 loc) · 2.04 KB

Developers

Dev dependencies

CLI options

Run ESLint on project sources:

$ npm run lint

Generate Swagger OpenAPI definitions:

$ npm run genapi

Generate documentation using JSDoc:

$ npm run gendoc

Known issues

Project files are assigned incorrect priviledges

If you experience this when working between local/remote development environments this is due to the user UID not being present during build time. In this case the default 1000 is defined as both the UID/GID for the remote user. You can override this behavior by updating the following project devcontainer.json build arguments or by exporting the UID/GID in your .bash_profile.

"build": {
  "dockerfile": "Dockerfile",
  "args": {
    "UID": "${localEnv:UID:1234}", // Default to 1234
    "GID": "${localEnv:GID:1234}"
  }
},

References

Contributions

If you fix a bug, or have a code you want to contribute, please send a pull-request with your changes. (Note: Before committing your code please ensure that you are following the Node.js style guide)