API Template

Express

This template uses express which has many examples and a lot of middlewares.

Inversify

This template uses InversifyJS for IoC and DI. See ./src/inversify.config.ts for bindings and ./src/types.ts for types.

inversify-express-utils

This template uses inversify-express-utils for express DI. An example controller can be found at ./src/controllers/example_controller.ts. These controllers look very similar to .NET Core MVC controllers.

Serverless

This template is setup to run/deploy through serverless and works really well with AWS Lambda Functions. We use a single lambda function for the entire API to reduce the frequency of cold starts. See the Webpack section on further techniques for cold start latency reduction.

See ./serverless.yml for serverless configuration.

Webpack

This template uses webpack and serverless-webpack to generate a bundled/minified index.js file which decreases the cold start latency.

Winston Logging

See this article for a general stack description.

Testing Logging Locally

See the elk-tool directory to setup a local ELK stack for local logging (.env.development.local is pointing to this).

Running Locally

npm start

GET on http://localhost:3000

Tests

npm test

Linting

npm run pretest

Code Coverage

npm run coverage

Startup Live Server and navigate to .coverage/lcov-report/index.html.