diff --git a/README.md b/README.md index fc72e98..1bb5772 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,12 @@

📦 REST API Starter Kit/Boilerplate powered by Node.js, Express.js, and TypeORM.

- - - - - - - - - - - - - - - - - - + + + + + +

@@ -39,17 +27,11 @@ ## Features - Dockerized Environment: Easily set up and manage your development environment using Docker. - - CLI for Resource Generation: Quickly generate resource files (controller, service, repository, DTO, entity, and route) using the CLI tool. - - Service Repository Pattern: Maintain a clean and modular codebase with a well-structured service repository pattern. - - Zod Validation: Ensure data integrity with schema-based validation using Zod. - - Class Transformer Output DTOs: Clean and transform your data with Class Transformer. - - Swagger UI and Redoc UI: Automatically generate and visualize your API documentation. - - ESLint and Prettier: Enforce coding standards and ensure a consistent code style. ## Getting Started @@ -134,6 +116,8 @@ This will generate the following files: The generated files will be pre-configured and ready for use, allowing you to focus on implementing your business logic. +Remember to create a migration for the new entity and add the route to the index route (src/routes/index.ts). + ## API Documentation This starter kit comes with integrated API documentation tools. You can access the Swagger UI and Redoc UI for your API documentation.