kennethgab / seans-typescript-nodejs-crud-rest-api-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

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

License: MIT License

TypeScript 89.92% Dockerfile 8.56% HTML 1.52%

seans-typescript-nodejs-crud-rest-api-boilerplate's Introduction

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

To help support this TypeScript boilerplate, please take a moment to look at my official TypeScript courses in

Three.js and TypeScript and

Socket.IO and TypeScript

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.