node-base-koa

What for

The Node Base offers an easier way to implement the coding practices recommended by Natura Architecture Team.

What it's included

• Docker environment
• Isomorphic code, capable to run in local environment, lambda and kubernetes
• Logging using the structure recommended
  • Logger module supporting with correlation id, session id, etc
  • Logging middleware to log input and output data
  • TypeORM logger module using the logger module
• Tests helpers to improve productivity
• Abstraction to use code practices recommended
  • Base Command to create events based commands
  • Koa Handler to create the interface between your domain and the Koa
  • Environment variables from AWS SSM
• Debug mode for development and tests

How to contribute

You can contribute submitting pull requests.

Setup

Run npm install.

Testing

Just run npm test.

Lint

To verify if any lint rule was broken run: npm run lint.

Update docs

Run npm run docs to generate a new documentation version.