coditech0926 / express-typescript-swagger

Express + TypeScript Swagger UI for Web API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸš€ Express TypeScript Boilerplate 2024

Hey There! πŸ™Œ 
🀾 that ⭐️ button if you like this boilerplate. 

🌟 Introduction

Welcome to the Express TypeScript Boilerplate 2024 – a streamlined, efficient, and scalable foundation for building powerful backend services with modern tools and practices in Express.js and TypeScript.

πŸ› οΈ Getting Started

Video Demo

For a visual guide, watch the video demo to see the setup and running of the project.

Step-by-Step Guide

Step 1: πŸš€ Initial Setup

  • Clone the repository: git clone https://github.com/coditech0926/express-typescript-swagger.git
  • Navigate: cd express-typescript-swagger
  • Install dependencies: npm ci

Step 2: βš™οΈ Environment Configuration

  • Create .env: Copy .env.template to .env
  • Update .env: Fill in necessary environment variables

Step 3: πŸƒβ€β™‚οΈ Running the Project

  • Development Mode: npm run dev
  • Building: npm run build
  • Production Mode: Set .env to NODE_ENV="production" then npm run build && npm run start

🀝 Feedback and Contributions

We'd love to hear your feedback and suggestions for further improvements. Feel free to contribute and join us in making backend development cleaner and faster!

πŸŽ‰ Happy coding!

About

Express + TypeScript Swagger UI for Web API


Languages

Language:TypeScript 98.4%Language:Dockerfile 1.1%Language:Shell 0.5%