Basic template for creating an API project with node/typescript/swagger

Getting Started

Clone the repository and install the dependencies.

git clone https://github.com/jsalio/ExpressWebApiTemplate
cd ExpressWebApiTemplate
pnpm install

Prerequisites

• Node.js
• TypeScript
• Nodemon
• Express
• Swagger
• tsoa

Folder structure

├── README.md
├── package.json
├── lib
│   ├── app.ts
│   ├── server.ts
│   ├── app-router.ts # App router
│   ├── controllers # Controllers
│   │   ├── HomeController.ts
│   ├── models
│   │   ├── Response.ts
├── Public
│   ├── swagger.json # Swagger file (autogenerated)
├── nodemon.json
├── tsconfig.json
├── tsoa.json
├── tslint.json

How to run

• For build and run the project
  

  pnpm run start:dev
  

• For update swagger file
  

  pnpm run swagger
  

• For run in watch mode
  

  pnpm run start
  

Comments

[LMugget]

The link to the repository is broken and the commands are outdated, follow the updated instructions below:

git clone github.com/jsalio/BasicExpressTemp...
cd BasicExpressTemplateTypeScript2
npm i