Express Typescript Boilerplate
A delightful way to building a RESTful API with NodeJs & TypeScript by @w3tecch
Overview:
The main goal of this project is to provide a feature complete server application. The aim is to allow users to focus on their business rather than spending hours on project configuration. The project encourages user feedback and welcomes new feature suggestions.
Features:
- Beautiful Code: The project uses annotations from Pleerock libraries to ensure clean and aesthetically pleasing code.
- Easy API Testing: The project includes end-to-end testing for easier and more efficient API testing.
- Dependency Injection: Dependency Injection is implemented using the TypeDI framework to simplify the process.
- Simplified Database Query: The project uses TypeORM to provide a simplified approach to database querying.
- Clear Structure: The project follows a clear structure with different layers such as controllers, services, repositories, models, and middlewares.
- Easy Exception Handling: Exception handling is made easier thanks to routing-controllers.
- Smart Validation: Class-validator with annotations is used to implement smart validation for requests.
- Custom Validators: Custom validators are available to provide even stricter request validation.
- API Documentation: Swagger and routing-controllers-openapi are used to generate API documentation.
- API Monitoring: Express-status-monitor is used to monitor the API.
- Integrated Testing Tool: The project includes Jest for integrated testing.
- E2E API Testing: Supertest is used for end-to-end API testing.
- Basic Security Features: Helmet is integrated to provide basic security features.
- Easy Event Dispatching: Event dispatching is made easier thanks to event-dispatch.
- Fast Database Building: TypeORM allows for fast database building with simple migration.
- Easy Data Seeding: The project includes its own factories to make data seeding easier.
- GraphQL Support: The project provides support for GraphQL and uses TypeGraphQL for simplified usage.
- DataLoaders: DataLoaders are used to improve performance by caching and batching data.
Summary:
This project aims to provide a feature complete server application, allowing users to focus on their business instead of spending time on project configuration. It offers various features such as easy API testing, dependency injection, simplified database querying, and more. The installation process involves setting up the development environment, creating a new project, and serving the app.
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Graphql
A website that uses GraphQL as a query language to manage data fetching and state management. This includes features such as a strongly typed schema, client-side caching, and declarative data fetching to streamline data management and optimize website performance.
- 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.