Express API

A robust Express API server built with TypeScript, featuring comprehensive tooling for modern backend development.

Features

• TypeScript 5.8.x - Type-safe JavaScript
• Express 4.21.x - Fast, unopinionated web framework
• Zod 3.x - TypeScript-first schema validation
• PostgreSQL - Advanced open source database
• Code Quality
  • JavaScript Style with Standard with TypeScript
  • Code formatting with Prettier
  • ESLint and TypeScript ESLint integration
• API Documentation with Swagger OpenAPI 3.x
• Logging with Pino
• Containerization with Docker

Prerequisites

• Node.js >= 20.x
• PostgreSQL
• Docker (optional)

Module System

• By default, the main branch uses ES Modules (type: module)

Getting Started

1. Clone the repository

   git clone https://github.com/masb0ymas/express-api.git
   cd express-api

2. Set up environment variables

   cp .env.example .env

   Then configure database settings in the .env file.

   or you can generate .env with command:

   yarn secret

3. Install dependencies

   yarn install

4. Start development server

   yarn dev

   With file watching:

   yarn dev:watch

Deployment

Release Process

yarn release

Docker Deployment

# Build the Docker image
docker build -t yourname/express:v1.0.0 .

# Run the container
docker run -p 7000:8000 -d yourname/express:v1.0.0

Scripts

• npm run dev - Start development server with hot reloading
• npm run build - Build for production
• npm run start - Start production server
• npm run release - Release a new version

Author

Support