English | 简体中文

NestJS Template

Tech Stack

• Nest.js: A framework for building efficient, scalable Node.js applications.
• TypeORM: An ORM tool for database connection and operations.
• PostgreSQL: An open-source relational database management system.
• Redis: An open-source in-memory data structure store, used as a database, cache, and message broker.
• Swagger: A tool for generating API documentation.

Swagger UI is accessible at http://localhost:3000/api. If you're using APIFox or Postman, you can import the API documentation from http://localhost:3000/api-json

Running the Project

Start Database and Redis

docker compose up -f ./docker-compose.yml -d

To stop the docker containers, run docker compose -f ./docker-compose.yml down

Install Dependencies

npm install

Start the Project

npm run start:dev

Access the Project

1. Via Terminal

curl --location --request GET 'http://localhost:3000'

2. Via Browser

http://localhost:3000

Both methods will return Hello World!

Contact the Author

If you encounter any issues, besides GitHub Issues, you can find my contact information at wukaipeng.com.