53 lines (39 loc) · 1.1 KB

Tsoa-api-template

A robust TypeScript-based API template with built-in error handling, logging, and OpenAPI documentation using TSOA.

Features

🚀 TypeScript for type safety and better developer experience
📚 OpenAPI/Swagger documentation using TSOA
🔒 Built-in security with Helmet
📝 Winston logging
⚡️ Express.js for fast, unopinionated routing
🛡️ Rate limiting
✨ ESLint + Prettier for code consistency
🔄 Hot reloading with Nodemon

Prerequisites

Node.js >= 18
npm or yarn (yarn is preferred)

Installation

Clone the repository:

git clone git@github.com:thecodearcher/tsoa-api-template.git
cd tsoa-api-template

Install dependencies:
```
yarn install
```
Create a .env file:
```
cp .env.example .env
```
Start development server:
```
yarn dev
```

API Documentation

Once the server is running, access the Swagger documentation at:

http://localhost:3000/docs

TODO

Read as "Things I'll do when I am not lazy 🥲"

Add Prisma ORM for database access
Add Docker support??