Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.6 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.6 KB

A small project to show how to create from scratch a Rest API based on Express (Node.Js) & TypeScript.

This project is related to a series of videos (in French) to learn Express from scratch.

You can check the complete playlist (videos are in French) on my YouTube channel (Dev Propulsor) for step-by-step tutorials to get there from scratch.

Install dependencies

npm install

Build and start the project

npm run build
npm run start

Build and start the project in dev mode

In case you want to make some changes to the code, you can use the equivalent commands from the previous one but in dev mode (also known as watch mode) to automatically build and restart the project whenever there are changes in the code.

# Build the project in dev mode
npm run build:dev
# Start the project in dev mode
npm run start:dev

Branches :

  • master : project without any architecture
  • architecture_3tier : project with 3-tier architecture (Controller, Service, Repository)
  • crud__mongoose : save data into MongoDB using Mongoose as ODM.
  • jwt_authentication : JWT Authentication - Registration, Auhentication and Authorization.
  • deploy_ready_with_env_vars : Make application production ready using environment variables.
  • unit_test : Unit test the 3-tier architecture layers (Controller, Service, Repository).
  • integration_test : Integration test using Supertest.
  • error_handling__gracefully_shutdown : Properly handle uncaught error/exception and Gracefully shutdown.
  • dockerize : Dokerize app for deploiement based on docker compose.