kirillonishuk/seans-typescript-nodejs-crud-rest-api-boilerplate

A minimal and easy to follow example of what you need to create a CRUD style API in NodeJs using TypeScript

Seans-TypeScript-NodeJS-CRUD-REST-API-Boilerplate

MIT License

Rememeber, No guarantees, or even fit for a particular purpose.

This project will be updated slowly as required, so stay tuned.

If you have a suggestion, or you want to contribute some code, you are free to make a pull request.

Your contributions will be visible since this project is public.

Setup

npm install

Development with nodemon and tsc --watch

npm run dev

Then visit http://localhost:3000/cats

Run without nodemon and tsc --watch

npm start

Then visit http://localhost:3000/cats

Swagger

Visit http://localhost:3000/swagger to view the OPENAPI document in Swagger-UI

Video tutorial on setting up Swagger in an existing NodeJS TypeScript API

Continuous Integration and Deployment

I've also added gitlab-ci.yml and dockerised with Docker-Compose. See video tutorial on how all this works.

Heroku

You can also test this on heroku https://seans-typescript-nodejs-crud.herokuapp.com/cats

and view the Swagger-UI https://seans-typescript-nodejs-crud.herokuapp.com/swagger

Usage

List all records

Post (Create) Record

Get by Id

Put (Update) Record

Delete Record