HallSync BackEnd

table of contents

• Overview
• Configuring backend
• Languages, Tools and Frameworks
• Project Scope
• Mock UI
• Project Architecture
• API Reference
• Modules & Features
• 60% Video Demonstration
• Contributors
• Supervisor

Overview

This is the backend of CSE 408 Software Development term project HallSync By Syed Jarullah Hisham (1805004), Abdur Rafi (1805008) & A.H.M Osama Haque (1805002)
To see frontend of this project, please use this link: HallSync FrontEnd

Configuring backend

1. clone this repository or download the repository as zip and unzip it
2. typescript should be installed if not already installed. to install typescript globally, run

     npm install -g typescript

3. use terminal inside the project and run

     npm install

4. ensure postgres database is ready with a new schema
5. create a .env file at the root folder. In this file, add an arbitrary value for variable JWTSECRET for example:

     JWTSECRET="helloworld"

6. also add the postgres database url variable DATABASE_URL for example:

     DATABASE_URL="postgresql://postgres:hisham@localhost:5432/hallsync_v2?schema=public"

7. From terminal, Run

      npx prisma migrate dev

8. at the src folder, there is a generateData.ts file which will generate dummy data. From terminal, Run

      ts-node src/generateData.ts

9. lastly, run

     npm start

   This project should work perfectly now on "http://localhost:3000"

Languages, Tools and Frameworks:

frontend:

typescript, reactjs, nextjs, scss, apollo, graphql, react-bootstrap, material ui, recharts

backend:

typescript, nodejs, express, apollo, graphql, postgres, prisma

Project Scope

• Scope Presentation

Mock UI

• Mock UI Presentation

Project Architecture

• Architecture Presentation

API Reference:

• Sample API Reference
• Postman API Reference (Partial)

Modules & Features:

• Full Features Demo

60% Video Demonstration:

• Demo
• Rest 40% part with this 60% all demonstrated in the presentation provided in Modules & Features section

Contributors:

• Syed Jarullah Hisham (1805004)
• Abdur Rafi (1805008)
• A.H.M Osama Haque (1805008)

Supervisor:

• Dr. Mahmuda Naznin
  Professor
  Department Of Computer Science And Engineering
  Bangladesh University Of Engineering and Technology