From 23dc874b74e21689b3b2e5de1cb4bc28d7cf0d07 Mon Sep 17 00:00:00 2001
From: Aaron Lee <58136818+aaronleetw@users.noreply.github.com>
Date: Sat, 26 Feb 2022 22:03:59 +0800
Subject: [PATCH] Create README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5cd023
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Attendance
+This is the attendance system I made for my school. It was used for about half a semester stably but was later dropped because the school's IT department decided the services this utilized was not suitable to our school's infrastructure.
+
+I also created a much more robust [version 2](../../tree/v2) with MySQL, but was never presented.
+
+## Technologies used
+- Flask
+- Mailgun (for FORGET password)
+- v1 only technologies
+  - Pyrebase (Firebase Realtime Database + Authentication)
+- v2 only technologies
+  - MySQL
+  - Flask_Admin
+  - SQL Alchemy
+  - OpenPyXL
+
+## v1 Screenshots
+- v1 Screenshots are avaliable [at my website](https://aaronlee.tech/projects/)
+
+## v1 Introduction
+[This is a link to the slides I used to present the system to our teachers](https://hackmd.io/@aaronlee/attendance-en-ppt/)
+
+## v2 Improvements
+After collecting feedback on v1, I created v2 with the intention of making teachers' lives easier. It's a shame v2 did not make it to production.
+
+Main improvements include:
+- Din-Shin (This is our school's special grading system, where every teacher can give a score on a scale of 1-5 depending on how the students behave in that period)
+  - This can save another piece of paper
+- Pre-recorded absence
+  - The student's affairs office can record absence ahead of time
+- Different absent types
+  - A student will have many reasons for their absence: sick, official, etc.
+- A robust database manager powered by Flask-Admin
+- Everyone has their individual note area (not share a big area)
+- Substitute class
+  - Sometimes even teachers have things to deal with. They can switch classes with other teachers, and the attendance system will still work fine.
+- Student have their own account for checking their records and make sure everything is correct.
+- Group classes are "grouped" into one button instead of appearing separately in the dropdown.
+
+## v2 Screenshots
+![](https://i.imgur.com/lSxjAc8.png) ![](https://i.imgur.com/jkr9HPy.png) ![](https://i.imgur.com/BIdMqFJ.png) ![](https://i.imgur.com/Ae2nO4z.png) ![](https://i.imgur.com/52dTvre.png)