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

To help support this TypeScript boilerplate, please take a moment to look at my official Design Patterns in TypeScript book and TypeScript Courses.

Three.js and TypeScript

Socket.IO and TypeScript

Paperback : ASIN B0948BCH24, eBook : ASIN B094716FD6

MIT License

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

If you have a suggestion, or you want to contribute some code, you can 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

TypeScript Courses

If you got this far, you probably like TypeScript just like I do, I have created two TypeScript courses specializing in the Three.js and Socket.IO libraries that you may find useful.

Threejs and TypeScript Course

Socket.io and TypeScript Course

Design Patterns In TypeScript

To help support my TypeScript projects, please check out my book titled Design Patterns in TypeScript.

   https://www.amazon.com/dp/B0948BCH24
   https://www.amazon.co.uk/dp/B0948BCH24
   https://www.amazon.in/dp/B094716FD6
   https://www.amazon.de/dp/B0948BCH24
   https://www.amazon.fr/dp/B0948BCH24
   https://www.amazon.es/dp/B0948BCH24
   https://www.amazon.it/dp/B0948BCH24
   https://www.amazon.co.jp/dp/B0948BCH24
   https://www.amazon.ca/dp/B0948BCH24
   https://www.amazon.com.au/dp/B094716FD6

(ASIN : B0948BCH24 / B094716FD6)

---

Thanks

Sean