Skip to content

kf1994/nodejs-typescript-project-structure

Repository files navigation

Backend Nodejs Typescript Directory Structure

How To Run

  1. Start by installing all dependencies by running npm install
  2. Next create a .env file at the root of the project and copy everything from .env.example
  3. copy files from .env.example to .env using cp .env.example .envthen populate it with required values where necessary.

Important Commands

  • run npm i or npm install to install all dependencies
  • run npm run dev to start a dev server
  • run npm start in a production environment
  • run npm run build to build the ts file to js
  • run npm run test to run unit tests

TODO

  • Add auth
  • Write tests