https://github.com/prthub/classroom

A Classroom Management System
https://github.com/prthub/classroom

Last synced: about 2 months ago
JSON representation

A Classroom Management System

• Host: GitHub
• URL: https://github.com/prthub/classroom
• Owner: PrtHub
• Created: 2024-08-10T11:39:59.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-12T09:51:26.000Z (6 months ago)
• Last Synced: 2024-11-07T19:46:50.731Z (4 months ago)
• Language: TypeScript
• Homepage: https://classroom-new.vercel.app
• Size: 127 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Classroom Management System

A full-stack web application designed to manage classroom activities efficiently, with role-based access for Principals, Teachers, and Students.

## Features

### User Roles

1. **Principal**

   - Create classrooms with specified schedules.

   - Assign teachers and students to classrooms.

   - Manage teacher and student accounts.

2. **Teacher**

   - Manage students within their assigned classroom.

   - Create and manage the timetable for their classroom.

3. **Student**

   - View their classroom timetable.

   - Access details of fellow students in their classroom.

### Login/Signup Process

- A default Principal account is created at app start:

  - **Email:** [email protected]

  - **Password:** Admin

- Principals can create accounts for Teachers and Students.

### Classroom Management

- Classrooms are created with a name, start time, end time, and the days in session.

- Timetables are created by Teachers within the classroom's schedule.

## Technology Stack

- **Frontend:** React, Vite, Tailwind CSS, TypeScript

- **Backend:** Node.js, Express, MongoDB, TypeScript

## Installation

1. Clone the repository.

2. Install dependencies: `npm install`.

3. Set up environment variables.

4. Start the backend: `npm run dev` for development or `npm start` for production.

5. Start the frontend: `npm run dev`.

## License

This project is licensed under the MIT License.