Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.63 KB

README.md

File metadata and controls

60 lines (40 loc) · 1.63 KB
Raw

node.express.starter

An Express.js starter project, built using Yarn2 and Typescript.

The starter project includes the following out of the box:

  • Authorization middleware
  • Error handling middleware
  • Logger middleware
  • Validation middleware
  • Database integration (TypeORM + PostgreSQL)
  • Containerization via Docker
  • Unit tests (100% coverage)
  • Integration tests (100% coverage)
  • Complete CI workflow (build -> test -> publish)

Test Coverage

Coverage lines Coverage functions Coverage branches Coverage statements

Getting Started

1. Clone the application

git clone https://github.com/nicolaspearson/node.express.starter.git

2. Build and run the app

Run the app in development mode:

yarn start:dev

The app will start running at http://localhost:3000

Run the app in release mode:

yarn start:docker

The app will start running at http://localhost:3000

Migrations

To generate missing migrations:

yarn db:migration:generate:missing InitialSchema

Contribution Guidelines

Never commit directly to main, create a feature branch and submit a pull request.