README.md

Express / TypeScript / TypeORM RESTful API boilerplate

Minimal boilerplate for building RESTful APIs with JWT authentication and role based authorization using Express, TypeScript, TypeORM, Postgres & Docker with focus on best practices and painless developer experience.

Requirements

• Node v14+
• Docker

Running

Easily set up a local development environment with single command!

• clone the repo
• npm run docker:dev 🚀

Visit localhost:4000 or if using Postman grab config.

What happened 💥

Two docker containers are created:

• one container instance with Postgres database seeded with 💊 Breaking Bad characters in Users table. Postgres database default credentials are user=walter, password=white, that can be modified in .env file (not added to .gitignore for demo purposes).
• and one Node (v14 Alpine) container instance with running boilerplate RESTful API service.

Features:

• Express framework
• TypeScript v4 codebase
• TypeORM using Data Mapper pattern
• Docker environment:
  • Easily start local development using Docker Compose with single command npm run docker:dev
  • Connect to different staging or production environments npm run docker:[stage|prod]
  • Ready for microservices development and deployment.
    Once API changes are made, just build and push new docker image with your favourite CI/CD tool
    docker build -t <username>/api-boilerplate:latest .
docker push <username>/api-boilerplate:latest
• Contract first REST API design:
  • never break API again with HTTP responses and requests payloads using type definitions
  • Consistent schema error response. Your frontend will always know how to handle errors thrown in try...catch statements 💪
• JWT authentication and role based authorization using custom middleware
• Set local, stage or production environmental variables with type definitions
• Logging with morgan
• Unit and integration tests with Mocha and Chai
• Linting with ESLint
• Prettier code formatter
• Git hooks with Husky and lint-staged
• Automated npm & Docker dependency updates with Renovate (patch version only)
• Commit messages must meet conventional commits format.
  After staging changes just run npm run commit and get instant feedback on your commit message formatting and be prompted for required fields by Commitizen

Other awesome boilerplates:

Each boilerplate comes with it's own flavor of libraries and setup, check out others:

• Express and TypeORM with TypeScript
• Node.js, Express.js & TypeScript Boilerplate for Web Apps
• Express boilerplate for building RESTful APIs
• A delightful way to building a RESTful API with NodeJs & TypeScript by @w3tecch

Contributing

All contributions are welcome!