API Docs · Report Bug · Request Feature

Velvet is a modern, customized, minimal API starter kit to kickstart your next REST API backend. This project provides a robust foundation for building modern, scalable, and maintainable web applications using Node.js, Express, TypeScript, and various other tools and libraries.

• 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.
• Authentication and Authorization: Secure your API with JWT-based authentication and role-based access control.
• Zod Validation: Ensure data integrity with schema-based validation using Zod.
• Class Transformer 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.
• Winston Logging: Centralized and customizable logging using Winston.
• Advanced searching: Searching capabilities with sorting, filtering, and keyword search.
• GitHub Actions: CI/CD workflows for testing and linting.

cp .env.example .env

docker compose up

This will start the application along with any other services defined in the docker-compose.yml file.

The application should now be running at https://localhost:3000 (or the port specified in your docker-compose.yml).

To run the migrations, you can use the following commands inside the Docker container:

npm run migration:generate --name=CreateUsers

Replace CreateUsers with name of the migration.

npm run migration:run

npm run migration:revert

One of the key features of this starter kit is the ability to quickly generate new resources (e.g., controllers, services, repositories, DTOs, entities, and routes) using the CLI tool.

• Run the generate command:

  npm run generate

• Follow the prompts to enter the resource name and select the file types to generate.

To generate a new resource called Article, run the command and follow the prompts:

  npm run generate

• Enter the resource name: Article
• Select the files to generate: entity, repository, service, controller, route, dto

This will generate the following files:

• src/entities/article.entity.ts
• src/repositories/article.repository.ts
• src/services/article.service.ts
• src/controllers/article.controller.ts
• src/routes/articles.ts
• src/dtos/article.dto.ts

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).

This starter kit comes with integrated API documentation tools. You can access the Swagger UI and Redoc UI for your API documentation.

• Swagger UI: https://localhost:3000/swagger
• Redoc UI: https://localhost:3000/redoc

You can also access the online API documentation here.

The project follows a modular folder structure:

src/
  ├── configs/           # Application configurations
  ├── constants/         # Application constants
  ├── controllers/       # Route controllers
  ├── dtos/              # Data Transfer Objects
  ├── entities/          # TypeORM entities
  ├── exceptions/        # Custom exceptions
  ├── interfaces/        # TypeScript interfaces
  ├── middlewares/       # App middlewares
  ├── migrations/        # Database migrations
  ├── repositories/      # Data access layer
  ├── routes/            # API routes
  ├── services/          # Business logic layer
  ├── utils/             # Utility functions
  ├── app.ts             # Application setup
.env                     # Environment variables
docker-compose.yml       # Docker Compose configuration
Dockerfile               # Docker configuration
tsconfig.json            # TypeScript configuration
.eslintrc.js             # ESLint configuration
.prettierrc              # Prettier configuration

To access the admin routes, the authenticated user's isAdmin column must be set to true in the database. You can update the isAdmin field using Adminer, a database management tool accessible at https://localhost:8080.

You can show your support by starring this project.

To contribute, see the contributing guide.

MIT License