Express-TypeScript-Boilerplate

This is a backend boilerplate code for ExpressJS in TypeScript.

Features

• TypeScript
• ExpressJS
• Prisma
• ESLint
• Prettier
• Jest
• Docker
• Docker Compose
• PostgreSQL

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

• Node.js (>= 14.15.0)
• Docker
• Docker Compose
• Prisma
• PostgreSQL (>= 12.0)
• Yarn
• Postman (for API testing)
• VSCode (or any other code editor)

Installation

1. Clone the repository

git clone [email protected]:funkycadet/express-typescript-boilerplate.git

2. Install dependencies

yarn install

3. Start the database

docker compose up -d db

4. Run database migrations

yarn migration:deploy

5. Generate Prisma client

yarn migration:generate

6. Seed the database

yarn prisma:seed

7. Start the server

yarn start:dev

Visit http://0.0.0.0:7000/health in your browser to see if the server is running.

If you would prefer to use Docker to spin up the server, you can run the following command:

docker compose up -d

To check the logs, run:

docker compose logs -f {service-name}

where service name is the name of the service you want to check the logs for.

License

This project is licensed under the MIT License - see the LICENSE file for details.

API Documentation

For API documentation, visit this link