TS Backend Production Setup

A production-ready TypeScript backend boilerplate with Docker, Nginx, and comprehensive tooling. Whenever you need to set up a backend with TypeScript following standard industry practices, you can use this repository as a base or reference.

It’s structured in a clean, scalable, and production-ready way — including proper folder organization, TypeScript configuration, and best practices for maintainability and performance.

🚀 Features

• TypeScript - Type-safe backend development
• Express.js - Fast and minimal web framework
• Docker - Containerized deployment
• Nginx - Reverse proxy and load balancing
• Database Migrations - Schema version control
• Code Quality Tools - ESLint, Prettier, Husky
• Hot Reload - Development with Nodemon

📋 Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16 or higher)
• npm or yarn
• Docker (optional, for containerized deployment)
• PostgreSQL or your preferred database

🛠️ Installation

1. Clone the Repository

git clone https://github.com/HardCoder404/TS-Backend-Production-Setup.git
cd TS-Backend-Production-Setup

2. Install Dependencies

npm install

3. Environment Configuration

Create environment files based on your deployment environment:

For Development:

Create a .env.development file in the root directory:

# General
ENV=development #production
PORT=3000
SERVER_URL=http://localhost:3000

# Database
DATABASE_URL=""

# Migration
MIGRATE_MONGO_URI="" # Same as database url
MIGRATE_AUTOSYNC="true" # false

For Production:

Create a .env.production file in the root directory:

# General
ENV=development #production
PORT=3000
SERVER_URL=http://localhost:3000

# Database
DATABASE_URL=""

# Migration
MIGRATE_MONGO_URI="" # Same as database url
MIGRATE_AUTOSYNC="true" # false

⚠️ Important: Never commit .env files to version control. They are already in .gitignore.

🏃 Running the Application

Development Mode

Start the development server with hot reload:

npm run dev

Production Mode

Build and run the production server:

npm run build
npm start

📜 Available Scripts

Command	Description
npm run dev	Start development server with hot reload
npm start	Run production build
npm run build	Compile TypeScript to JavaScript
npm run lint	Check code for linting errors
npm run lint:fix	Fix linting errors automatically
npm run format	Format code with Prettier
npm run format:check	Check if code is formatted correctly
npm run migrate	Run database migrations

🐳 Docker Deployment

Build Docker Image

# development
docker build -t backend-app:dev -f docker/development/Dockerfile .

# production
docker build -t backend-app:dev -f docker/production/Dockerfile .

Run Container

# development
docker run --rm -it -v ${PWD}:/usr/src/backend-app -v /usr/src/backend-app/node_modules -p 3000:3000 backend-app:dev

# production
docker run --rm -d -v ${PWD}:/usr/src/backend-app -v /usr/src/backend-app/node_modules -p 3000:3000 backend-app:dev

Stop Containers

ctrl+c

🔍 Code Quality

Linting

This project uses ESLint for code linting:

npm run lint

Formatting

Code formatting is handled by Prettier:

npm run format:check

Pre-commit Hooks

Husky ensures code quality before commits:

• Runs linting
• Runs formatting checks
• Validates commit messages

📝 Database Migrations

Create a New Migration

npm run migrate:create -- migration_name

Run Migrations

npm run migrate

Rollback Migrations

npm run migrate:rollback

🚢 Deployment

Production Checklist

• Set NODE_ENV=production
• Use strong JWT secrets
• Configure proper database credentials
• Set up proper logging
• Enable CORS for specific domains
• Set up SSL/TLS certificates
• Configure environment variables
• Run database migrations
• Test all API endpoints

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License.

👨‍💻 Author

HardCoder404

🙏 Acknowledgments

• Express.js community
• TypeScript team
• All contributors

---

Happy Coding! 🚀