Boilerplate for Express and PostgreSQL Integration with TypeScript and Prisma

This repository provides a boilerplate for building a backend API using express and CRUD operations with PostgreSQL as the database. It is designed to streamline the development process by offering a pre-configured setup that integrates these technologies seamlessly.

Features

• TypeScript Support: Leverage TypeScript's static typing for enhanced code quality and developer experience.
• Express Setup: Pre-configured with Express for rapid API development.
• Environment Configuration: Easily manage environment variables using dotenv.
• ESLint: Pre-configured for consistent code style and linting.
• Jest: Ready-to-go setup for unit and integration testing.
• Swagger UI: Auto-generated API documentation using Swagger.
• PostgreSQL: Pre-configured with PostgreSQL for database integration.
• Prisma: Pre-configured with Prisma for database integration.

Getting Started

Prerequisites

• Node.js (>= 18.x recommended)
• Yarn or npm

Installation

# Clone the repository
git clone https://github.com/rochiyat/express-typescript-postgres-boilerplate.git

# Navigate into the directory
cd express-typescript-postgres-boilerplate

# Install dependencies
yarn install
# or
npm install

Seeding the Database

Seeding with the seed script will populate the database with sample data library static-mock-data-seeder. Can you see in repo https://github.com/rochiyat/postgres-mock-seeder Make sure to install it before running the seed script & application connect to the database.

# Create the tables
npx prisma init
npx prisma migrate dev --name init

# Run the seed script
yarn seed
# or
npm run seed

Running the Application

# Start the development server
yarn dev
# or
npm run dev

The server will start on http://localhost:3000 by default.

Building for Production

yarn build
# or
npm run build

This will compile the TypeScript code into JavaScript under the dist directory.

Running Tests & Coverage

yarn test
yarn test:coverage
# or
npm test
npm test:coverage

Project Structure

src/
│
├── configs/           # Configuration files
├── controllers/       # Route controllers (Controllers layer)
├── models/            # Data models (e.g., Mongoose schemas)
├── routes/            # Express routes
├── services/          # Business logic (Service layer)
├── utils/             # Utility functions and helpers
│
└── index.ts           # Entry point of the application
prisma/                # Prisma client
tests/                 # Unit and integration tests

Configuration

Environment variables are managed using a .env file. Here's an example:

PORT=3000
NODE_ENV=development

DEV_DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"
PROD_DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"

DATABASE_URL=${DEV_DATABASE_URL}

API Documentation

API documentation is automatically generated with Swagger and available at:

http://localhost:3000/api-docs

Contributing

Feel free to fork this project and submit a pull request with your improvements.

License

This project is licensed under the MIT License.

Acknowledgements

Special thanks to the open-source community for providing great libraries and tools!