AF Assignment - Timetable

Description

This is a project for AF Assignment focusing on a Timetable system.

Installation

Prerequisites

• Node.js (v14.x or higher)
• npm or yarn
• MongoDB

Steps

1. Clone the repository:

   git clone https://github.com/sliitcsse/assignment-01-russellpeiris.git

2. Navigate to the project directory:

   cd assignment-01-russellpeiris

3. Install dependencies:

   npm install

4. Create a .env file in the root directory and add the following environment variables:

   PORT=4000
   MONGO_URI=mongodb+srv://admin:admin@af.haslhbb.mongodb.net/
   JWT_SECRET=
   SALT_SECRET=
   MAIL_USER=
   MAIL_CLIENT_ID=
   MAIL_CLIENT_SECRET=
   REFRESH_TOKEN=
   REDIRECT_URI=

Running the Application

Development Mode

To run the application in development mode with nodemon:

npm run dev

Production Mode

To build and run the application in production mode:

npm run build
npm start

Linting and Formatting

To lint and fix the code:

npm run format

Seeding the Database

npm run seed

Run tests

npm run test

Postman Documentation and endpoints

Open Postman

Database Design