TIF-Assignment

A backend service that enables users to make their communities and add members to them.

Table of Contents

• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
• Environment Variables
• Usage
  • Development
  • Build
  • Start
• Dependencies

Tech Stack

Language: Typescript
Server: Node, Express
Database: MongoDB with Mongoose
Authentication: JSON-Web-Token used with httpOnly Cookies
Encryption: bcryptJS
Validator: express-validator

Getting Started

Prerequisites

To run this project, you need to have the following dependencies installed:

• Node.js

Installation

1. Clone the main repository to your local machine.

2. Install the project dependencies using npm:

   npm install
   

Environment Variables

Before running the server, you need to set up environment variables. Create a .env file in the root of your project and add the following variables:

Example .env file

PORT=3000
DB_CONNECTION_STRING=your-mongodb-url
AUTH_SEC_KEY=your-secret-key

Usage

Scripts

Development

To start development, run the following command:

npm run dev

Build

To Build the app, run the following command:

npm run build

Start the server

To start the app, run the following command:

npm run start

Dependencies

The project depends on the following npm packages:

• bcryptjs
• cookie-parser
• cors
• dotenv
• express
• express-validator
• jsonwebtoken
• mongoose
• ts-node