Skip to content

amoghmadan/TypeScript-Express-REST-Starter

Repository files navigation

TypeScript-Express-REST-Starter

Kick-starter to your REST application.

Node, Express, MongoDB, CLI and more.

Introduction

The project is a skeleton for an experss application and the way I like to configure it.

This structure is in no way a perfect fit all the projects, but might be a great fit for most big applications.

It contains login, logout and details for accounts, using custom token generation. The CLI provides user creation using commands and password change functionality as well.

How to setup?

  • Clone this project. PS: Delete the package-lock.json. You might want to rename the name & author in package.json and maintainer in Dockerfile.
  • Run: -
    npm i --location=project
  • Add an environemnt file .env to the root of the project and set your MONGODB_URI. Typically: -
    MONGODB_URI = mongodb://127.0.0.1:27017/<appname>
    
  • Create an admin user: -
    npm run dev createsuperuser
  • Run the development server: -
    npm run dev bootstrap