AI Classroom is a Django-based web application designed to facilitate online learning environments. It provides features for user authentication, classroom management, and user role-based access control.
- Features
- Prerequisites
- Installation
- Configuration
- Running the Application
- Project Structure
- Authentication
- Contributing
- License
- User authentication (login, logout, password reset)
- User roles (General Admin, Class Admin, Teacher, Student)
- Classroom creation and management
- Responsive design using Tailwind CSS
- Python 3.12.3 or higher
- pip (Python package manager)
- Git (version control)
-
Clone the repository:
git clone <repository-url> cd AIClassroom -
Create a virtual environment:
python -m venv venv -
Activate the virtual environment:
- On Windows:
venv\Scripts\activate - On macOS and Linux:
source venv/bin/activate
- On Windows:
-
Install the required packages:
pip install -r requirements.txt
-
Create a
.envfile in the project root and add the following:SECRET_KEY=your_secret_key_here DEBUG=True -
Update the database settings in
AIClassroom/settings.pyif needed.
-
Apply database migrations:
python manage.py migrate -
Create a superuser:
python manage.py createsuperuser -
Run the development server:
python manage.py runserver -
Access the application at
http://127.0.0.1:8000/
AIClassroom/: Main project directoryhome/: Main application directorytemplates/: HTML templatesstatic/: Static files (CSS, JavaScript, images)manage.py: Django management script
The project uses Django's built-in authentication system with custom user models. Password reset functionality is implemented using Django's PasswordResetView.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License.