Backend Website Himti

Backend tech stack: MongoDB + Express.js + Node.js (typescript)

Docs made using swagger.

Table of Contents

• Table of Contents
• Getting started
  • Set up your .env
  • Available Scripts
    • npm start
    • npm run dev:ts
    • npm run watch
    • npm run build
  • Run in ease while developing

Getting started

Before contributing please consider reading some of the docs:

• CONTRIBUTING.md
• resources.md

To start developing, first make sure that you have node installed. After that do npm install or npm ci to install all the dependencies.

Set up your .env

Don't forget to set up your .env file located in root folder. You can follow the template in the .env.example file.

Available Scripts

In the api directory, you can run:

npm start

Runs the API in the production mode (Compiled).

npm run dev:ts

Runs the API in the development mode (Not compiled).

npm run watch

Watches and re-compiles on every changes made to the codebase.

npm run build

Builds the API for production to the dist folder.

Run in ease while developing

• open a new terminal and run npm run watch
• then open another terminal and run npm run dev

this will get faster as it automatically re-compiles on the background