Typeorm Express Typescript
Minimal Express RESTful API boilerplate. Spin it up with single command. TypeScript, TypeORM, Postgres, Docker.
Overview:
The Heisenberg Boilerplate is a robust RESTful API boilerplate built with TypeORM, Express, and TypeScript. It focuses on best practices and provides a seamless developer experience with minimal setup. This boilerplate offers features such as JWT authentication, Docker environment setup, role-based authorization, and automated testing, making it a versatile choice for building scalable applications.
Features:
- Express framework
- TypeScript v4 codebase
- TypeORM using Data Mapper pattern
- Easily start local development using Docker Compose
- Connect to different staging or production environments
- JWT authentication with role-based authorization
- Contract-first REST API design
- Consistent schema error response
- 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
- Conventional commit messages format with Commitizen
Summary:
The Heisenberg Boilerplate provides a solid foundation for building RESTful APIs with modern technologies. Its thoughtful features like Docker for easy setup, JWT authentication, and automated testing make it a practical choice for developers aiming for efficiency and best practices in API development. By leveraging TypeScript, Express, and TypeORM, this boilerplate streamlines the development process while ensuring scalability and maintainability in the long run.
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- Fullstack
A fullstack boilerplate provides a starter application that includes both frontend and backend. It should include database, auth, payments, user roles and other backend services to build a fully featured saas or webapps.
- Docker
A website that uses Docker for containerization to streamline development, testing, and deployment workflows. This includes features such as containerization of dependencies, automated builds and deployments, and container orchestration to ensure scalability and availability.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.