Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
harshithl1777 committed Dec 19, 2023
1 parent 68a54bb commit de88219
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<img width="1512" alt="Screenshot 2023-12-18 at 10 59 12 PM" src="https://github.com/harshithl1777/relay/assets/44104695/02dced17-f5c0-46f8-bfa2-4690e7d97bd9">

# Relay

### Description

Taking attendance is one of the most time consuming and complicated things in school. For starters, teachers have read through the whole list of students in the class which takes up a lot of time, especially for 1-hour classes. Also, on days when substitute teachers are present, it's not uncommon to have the a few students cringe when their name gets butchered. That's where Blitz comes in.

### How it works

With Relay, taking attendance would look like this:
1. A teacher starts a new **attendance session** for their appropriate class and receives a QR code.
2. Students can then scan the QR Code, which takes them to a URL to enter in their details and save their attendance.
3. After filling a few fields (full name, student ID and email address), the student will be marked as present.
4. These attendance records will start showing up on the teacher's side of the app in **realtime**.
5. All the attendance records will then be saved to a history tab after the attendance session ends for the teacher's reference.

### Tech Stack
- `React`, `Redux`, `Firebase`, `Chakra UI`

### Gallery

| | |
|:-------------------------:|:-------------------------:|
|<img width="1511" alt="Sign Up Page" src="https://user-images.githubusercontent.com/44104695/195221351-3d5530ad-0c81-4e6f-9568-8ba946e7d3f6.png"> Sign Up Page | <img width="1512" alt="Active Session Page" src="https://user-images.githubusercontent.com/44104695/195221538-ec6c59fa-02e6-4949-bcdd-3f2d2d6287d1.png"> Active Attendance Sessions|
|<img width="1511" alt="Attendance History Page" src="https://user-images.githubusercontent.com/44104695/195221791-dddfafc7-ba1c-41ac-b40a-254846125553.png"> Attendance History|<img width="1512" alt="Students Page" src="https://user-images.githubusercontent.com/44104695/195221973-50f792bc-3b02-481c-9aad-14bb48f4cad1.png"> Students Page |

0 comments on commit de88219

Please sign in to comment.