node-starter

Start application

• Install dependencies yarn install
• Start with local project yarn dev

Tech Stack

This project is a seed for building a node.js api. It includes the following features:

• tsoa integrated OpenAPI compiler framework
• tsyringe inversion of control / dependency injection
• swagger-ui-express auto-generated swagger-ui generated API docs from express
• mocha, chai, supertest, ts-mockito unit and integration testing tools
• typeorm SQL ORM

Where can I find the API Swagger documentation ?

• <url>/docs

Which is the endpoint URL?

• <url>

Commands

• installation: yarn install download dependencies
• test: yarn test unit and integration tests
• build: yarn build production build
• dev: yarn dev starts the server on development mode
• local yarn local starts the server with nodemon locally

CI/CD

Currently Github Actions workflows is implemented for CI/CD

Workflow Summary:

• Tests run(unit and integration tests).
• Creates new Docker image.
• Pushes new docker version into AWS ECR.
• Deploys new version into AWS ECS Cluster.

Download latest docker image

• https://gallery.ecr.aws/b1x7g5t5/node-starter