A robust TypeScript-based API template with built-in error handling, logging, and OpenAPI documentation using TSOA.
- π 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
- Node.js >= 18
- npm or yarn (yarn is preferred)
-
Clone the repository:
git clone git@github.com:thecodearcher/tsoa-api-template.git cd tsoa-api-template -
Install dependencies:
yarn install
-
Create a
.envfile:cp .env.example .env
-
Start development server:
yarn dev
Once the server is running, access the Swagger documentation at:
- Add Prisma ORM for database access
- Add Docker support??