HallSync FrontEnd

table of contents

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

Overview

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

Configuring frontend

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 backend is configured and running correctly on "http://localhost:3000" (note the port number)
5. using the terminal inside project, run

 npm run dev

that's it. This project should work perfectly now on "http://localhost:3001"

Production build

6. (optional) in case of production build, run

 npm run build

7. (optional) after build is finished, run

 npm start

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