MTrace: Backend Application.

The back end application for the Mtrace Expense Tracker application.

Tech Stack

• Node.JS
• Express
• MongoDB
• Language: TypeScript

Corressponding frontend"

The Corressponding Frontend built on ReactJS can be found here.

Local setup for development

Prerequisites:

• Node.JS version 18.X or higher
• Git version 2.30.X or higher
• Preferred Code Editor or IDE (Suggested: Visual Studio Code)

Set up:

• Clone the repository onto your local machine,
• In the root directory, run npm install
• Create a .env file in the root directory and add the following keys to it.

PORT=6400
# PROBE_PORT
NODE_ENV=development
JWT_SECRET=
DB_URI=
ORIGINS=http://localhost:5173

Note 1: The values for DB_URI & JWT_SECRET variables will be provided separately.

Note 2: The option PROBE_PORT is optional, as it is for a feature which is not yet planned.

• Run npm run dev to start the development server on http://localhost:6400

Suggested Folder/File Structure:

root
|   .env
|   .gitignore
|   nodemon.json
|   package-lock.json
|   package.json
|   Readme.md
|   tsconfig.json
+---.vscode
|       settings.json
\---src
    |   index.ts
    +---config
    |       db.ts
    +---constants
    |       <type>.constants.ts
    +---controllers
    |       <controller_name>.controller.ts
    +---env
    |       config.ts
    +---middlewares
    |       <middleware_name>.middleware.ts
    +---models
    |       <model_name>.model.ts
    +---routes
    |       <router_name>.routes.ts
    \---types
            type_name.ts

Suggested Extensions and Plugins :

(If using Visual Studio Code)

Utilities:

• GitLens
• Prettier
• Todo Tree
• ESLint

Visual Enhancements:

• Material Icon Theme [for file/folder icons]
• Carbon Product Icons [for application icons]
• One Dark Pro [application color theme]