|
| 1 | +# 📚 Gamified Reading Platform |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +<br> |
| 10 | + |
| 11 | +## 📖 Overview |
| 12 | + |
| 13 | +This project is a **gamified reading platform** designed to increase young students' interest in books. |
| 14 | + |
| 15 | +The system uses **gamification techniques** such as levels, reading streaks, and activity tracking to motivate students to read more frequently and engage with books in a structured and enjoyable way. |
| 16 | + |
| 17 | +The platform also allows **teachers, librarians, and administrators** to monitor student activity and manage books and classes. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 🎯 Project Goal |
| 22 | + |
| 23 | +The main objective of the system is to **encourage reading among younger students**. |
| 24 | + |
| 25 | +To achieve this, the platform introduces **game-like mechanics**, allowing students to track their progress, maintain reading streaks, and interact with books and reading groups. |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +# 👥 User Roles |
| 30 | + |
| 31 | +The system supports four types of users: |
| 32 | + |
| 33 | +- **Student** |
| 34 | +- **Teacher** |
| 35 | +- **Librarian** |
| 36 | +- **Administrator** |
| 37 | + |
| 38 | +Each role has specific responsibilities and permissions. |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +# 🚀 Features |
| 43 | + |
| 44 | +## 👨🎓 Student |
| 45 | + |
| 46 | +The **student** is the primary user of the platform and has access to most features. |
| 47 | + |
| 48 | +- Register (using a class code) |
| 49 | +- Login |
| 50 | +- View personal statistics: |
| 51 | + - Level |
| 52 | + - Average reading time |
| 53 | + - Last book read |
| 54 | + - Reading streak |
| 55 | +- Search for books |
| 56 | +- Start a reading session |
| 57 | +- Finish a reading session |
| 58 | +- Submit a summary of the pages read |
| 59 | +- Create reading groups |
| 60 | +- Rename or remove groups |
| 61 | +- Add books to a group |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +## 👨🏫 Teacher |
| 66 | + |
| 67 | +Teachers are responsible for **monitoring students from their class**. |
| 68 | + |
| 69 | +- Login |
| 70 | +- View the list of students in their class |
| 71 | +- Access student information such as: |
| 72 | + - Level |
| 73 | + - Average reading time |
| 74 | + - Last book read |
| 75 | + - Last submitted summary |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## 📚 Librarian |
| 80 | + |
| 81 | +The librarian is responsible for **book management**. |
| 82 | + |
| 83 | +- Login |
| 84 | +- Manage the book catalog: |
| 85 | + - Add books |
| 86 | + - Remove books |
| 87 | + - Update book information |
| 88 | + - List available books |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +## 🛠 Administrator |
| 93 | + |
| 94 | +The administrator manages **users and classes** within the system. |
| 95 | + |
| 96 | +- Register new users |
| 97 | +- Login |
| 98 | +- Manage classes: |
| 99 | + - Create classes |
| 100 | + - List classes |
| 101 | + - Update class information |
| 102 | + - View class details |
| 103 | +- Generate **expiring registration links** for new users (teachers or librarians) |
| 104 | + |
| 105 | +--- |
| 106 | + |
| 107 | +# 🧠 AI Integration |
| 108 | + |
| 109 | +The platform uses **Artificial Intelligence** to classify the **difficulty level of books**. |
| 110 | + |
| 111 | +The AI analyzes the book content and categorizes it into one of three levels: |
| 112 | + |
| 113 | +- **Easy** |
| 114 | +- **Medium** |
| 115 | +- **Hard** |
| 116 | + |
| 117 | +This classification helps students choose books appropriate for their reading level and allows teachers to better guide student reading development. |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +# 🧱 Tech Stack |
| 122 | + |
| 123 | +| Layer | Technology | |
| 124 | +|------|-------------| |
| 125 | +| **Backend** | Java, Spring Framework | |
| 126 | +| **Frontend** | HTML, CSS, JavaScript | |
| 127 | +| **Database** | MySQL | |
| 128 | +| **Infrastructure** | Docker | |
0 commit comments