updated .gitignore

.gitignore

@@ -1 +1,2 @@
-__pycache__
+__pycache__
+school.db

README.md

@@ -1,28 +1,30 @@
 # **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)
 - [Features](#features)
 - [Installation](#installation)
-- [Usage](#usage)
 - [Statistics](#statistics)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## 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 ⚙️
 
@@ -31,3 +33,46 @@ To get started with **School Planner**, follow these simple installation steps:
 1. Clone the repository:
    ```bash
    git clone https://gitea.grevsmuehl.org/jasper/schoolplanner.git
+
+2. Navigate to the frontend directory:
+   ```bash
+   cd schoolplanner/frontend
+
+3. Install frontend dependencies:
+   ```bash
+   pip install -r requirements-frontend.txt
+
+4. Run the frontend with Flet:
+   ```bash
+   flet run --web --host 0.0.0.0 --port 9000 main.py
+
+5. Open a new terminal window, and navigate to the main project directory (schoolplanner):
+   ```bash
+   cd ..
+
+6. Install backend dependencies:
+   ```bash
+   pip install -r requirements-backend.txt
+
+7. Run the backend with Uvicorn:
+   ```bash
+   uvicorn main:app --reload --host 0.0.0.0
+
+
+## Commit Statistics 📈
+
+- **Last Commits**: ![Last Commit Badge](https://img.shields.io/gitea/last-commit/jasper/schoolplanner?gitea_url=https%3A%2F%2Fgitea.grevsmuehl.org%2F)
+
+## Contributing 🌱
+
+We welcome contributions from the community! To contribute to **School Planner**, follow these steps:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Make your changes and commit (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature-name`).
+5. Create a pull request to the main branch.
+
+## License 📝
+
+**School Planner** is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.