From 594be938e15513dc82608049ba91580333f8320e Mon Sep 17 00:00:00 2001 From: jasper Date: Sun, 19 Jan 2025 00:30:21 +0100 Subject: [PATCH] updated README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e10a00e..043823f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # **School Planner** 📚 -Welcome to **School Planner**, a dynamic and feature-packed project that helps you manage your school schedule, tasks, and activities. Built with **FastAPI** and **Flet**, this app offers both a backend API and a frontend for an amazing user experience. +Welcome to **School Planner**, a comprehensive tool designed to help manage classroom activities and schedules. Built with **FastAPI** for the backend and **Flet** for the frontend, this app provides a seamless experience for both teachers and students to organize their rooms and schedules. ## Table of Contents 📚 - [Introduction](#introduction) @@ -13,16 +13,19 @@ Welcome to **School Planner**, a dynamic and feature-packed project that helps y ## Introduction ✨ -**School Planner** is a comprehensive tool designed to streamline your academic life. It allows you to plan and organize your daily activities, assignments, and events with ease. The project consists of a robust backend built with **FastAPI** and a beautiful frontend powered by **Flet**. +**School Planner** simplifies classroom management for teachers and students. Teachers can create rooms, set schedules, and manage student participation. Students can view available rooms, check their schedules, and track their involvement in different rooms. This app is powered by **FastAPI** for the backend and **Flet** for the frontend. ## Features ⚡ -Here are the key features of **School Planner**: -- **Interactive Dashboard**: View your upcoming assignments, exams, and activities in a single place 📅. -- **Task Management**: Add, update, and remove tasks to stay on top of your assignments and deadlines 📝. -- **Calendar View**: Visualize your schedule and plan ahead with a calendar interface 📆. -- **Notifications**: Get reminders for upcoming deadlines and events 🔔. -- **Responsive Design**: The frontend is designed to work seamlessly across devices and platforms 💻📱. +### **Teacher Features:** +- **Create Rooms**: Teachers can create rooms with essential information, such as room name, maximum number of students, date, and time 🏫. +- **List Open Rooms**: Teachers can view a list of all open rooms to monitor available spaces 📋. +- **Track Logged Students**: Teachers can view the list of students logged into the room to track participation 🧑‍🏫. + +### **Student Features:** +- **See Joined Rooms**: Students can see the list of rooms they are currently enrolled in and their schedules 📅. +- **View All Rooms**: Students can browse all available rooms and their details 🌐. +- **Color-coded Rooms**: Rooms are displayed with different colors to make it easier for students to differentiate between them 🎨. ## Installation ⚙️