cs3305-team-4 / astratutor Goto Github PK

View Code? Open in Web Editor NEW

8.0 0.0 1.0 17.2 MB

AstraTutor - WebRTC-based tutoring platform with Stripe payments. Go+Postgres backend, React frontend

Home Page: https://cs3305-team-4.github.io/astratutor/documents/Project%20Documentation%20[FINAL].pdf

Dockerfile 0.10% Go 39.46% JavaScript 9.41% HTML 0.40% TypeScript 50.53% CSS 0.10%

react typescript javascript reactjs

astratutor's Introduction

AstraTutor

This repo serves as the monorepo for the AstraTutor application for Team 4 of the CS3305 Team Software Project module

Instructions

We have 2 test accounts for logging in

Tutor email:        [email protected]
Tutor password:     grindsapp

Student email:      [email protected]
Student password:   grindsapp

To look at pg admin use the following credentials

Email:              [email protected]
Password:           grindsapp

Second password:    grindsapp

Use website

Visit astratutor.com

Install Locally

Clone the repo
Run docker-compose up and visit:
- https://localhost:8080 for UI
- https://localhost:8081 for API
- https://localhost:8082 for pgAdmin

This will take some time to start as it needs to seed the database

Folder Structure

.
|-- api                 Contains GO Backend
|   |-- cmd             Contains script used to start webserver
|   |-- pkg             Contains backend code
|   |   |-- database    Contains code to open database connection
|   |   |-- routes      Contains code to define api endpoints
|   |   `-- services    Contains services code
|   `-- seed            Contains data used for seeding
|-- documents           Contains various documents for project
|-- pgadmin4            Contains config for pgadmin
`-- ui                  Contains React frontend
    |-- public          Contains Static files
    `-- src             Contains frontend components
        |-- api         Contains typescript for interfacing with backend
        |-- components  Contains react components
        |-- views       Contains pages
        `-- webrtc      Contains typescript for webrtc connections

Documentation

https://cs3305-team-4.github.io/astratutor/documents/Project%20Documentation%20%5BFINAL%5D.pdf

astratutor's People

Contributors

Stargazers

Forkers

dangolbeeker

astratutor's Issues

Skeleton frontend

https://www.figma.com/file/r8tkPurbqSH0vC8njZM5lu/AstroTutor-Front-End?node-id=11%3A4

Teaching a subject

A tutor should be able to sign up to tutor a subject on the site.
They provide a description for the subject and a price

Fix issue with tutor listing not maintaining state between pages

When using the browsers back/forward buttons on the tutor listing it doesnt correctly update the page state, e.g. ?page=3 will get removed from the url but the ui will remain on page 3

Sorting/Searching on tutor listing

Should be able to sort tutor listing on price and rating and any other relevant attributes
Should be able to search on tutor listing.
https://info.crunchydata.com/blog/fuzzy-name-matching-in-postgresql

Landing Page UI

Update Seeding

Include better seeding with simple methods to add accounts, and randomized data to add hundreds of entries as dummy data

WebRTC Classrooms

Ratings/Reviews

Students should be able to rate their tutors

Classroom UI

Design database schema

/lesson/* endpoints

Tutors Search UI

Skeleton WebRTC implementation

Lesson Resources & PDFjs preview

UI Improvements

Go over and fix issues related to UI and general clean up

Lessons List UI

Whiteboard

Lessons should have a whiteboard with pencil/pen, line, eraser

Design API endpoints (see meeting minutes)

Taught Subjects UI

Add UI to Profile showcasing a list of subjects they are teaching that can be edited and added to

Reporting system

A tutor can report a student with a reason.
A student can report a tutor with a reason.
The reports will be accessible from the admin dashboard where an employee can investigate the report

GDPR

A user should be able to download all their data in compliance with GDPR.
A user should be able to delete their data (terminate their account) under compliance with GDPR

Payment System

As a student I should be able to link my credit card/debit card (before allowed to request a lesson)
As a student I should be charged when the lesson is complete
When a student requests a lesson, an invoice is created on the price for that lesson that time
An invoice is charged at the end of a lesson:
The student is still charged if they don't turn up
The student is not charged if the tutor doesn't turn up
The tutor needs to be present for length of the lesson
As a tutor I should be able to link my bank account with my account
As a tutor I should be able to see my current balance (list of invoices that haven't been paid out to my bank account)