Sparleom

Table of Contents

• Introduction
• Features
• Demo
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

Introduction

The Education System is a comprehensive web-based platform designed to facilitate various aspects of educational institutions. This system is developed with the goal of streamlining processes related to student management, course administration, and instructor coordination. Built using Django for the backend and Angular for the frontend, it offers a robust solution for educational organizations to manage their resources efficiently.

Features

• User Management: Users can register, log in, and manage their profiles. Different roles such as students, instructors, and administrators are supported.

• Student Profiles: Students can create and update their profiles, including personal information and course enrollments.

• Instructor Profiles: Instructors can manage their profiles, including contact details and department affiliations.

• Course Management: Administrators can add, edit, and delete courses. Instructors can manage the courses they are assigned to.

• Enrollment System: Students can enroll in courses, view course materials, and track their progress.

• Grading: Instructors can grade assignments and assessments, and students can access their grades.

Demo

Explore our live demo to see the Education System in action. You can experience user registration, course enrollment, and other key features.

Getting Started

Follow these steps to set up the Education System on your local machine.

Prerequisites

To run the Education System locally, you'll need the following software and dependencies:

• Python 3.6+
• Node.js and npm
• PostgreSQL database

Installation

1. Clone the Repository:

   git clone https://github.com/yourusername/education-system.git

2. Create and Activate a Virtual Environment:

python -m venv venv
   source venv/bin/activate

3. Install Python Dependencies:

   pip install -r requirements.txt

4. **Install Angular Dependencies:**
```bash
cd frontend
npm install

5. Database Setup:

Create a PostgreSQL database and configure the database settings in settings.py.

Apply migrations:

6.Run the Application:

Start the Django development server:

python manage.py runserver

Start the Angular development server (in another terminal):

cd frontend
ng serve

Access the Application:

Open a web browser and navigate to http://localhost:4200/ to access the Education System.

Usage

The Education System is designed to be intuitive and user-friendly. Here are some basic usage instructions:

User Registration:

Sign up as a student, instructor, or administrator. Fill in your profile details. Course Management:

Administrators can add and manage courses. Instructors can assign themselves to courses they teach. Student Enrollment:

Students can enroll in available courses. Access course materials and assignments. Grading:

Instructors can grade assignments. Students can view their grades.

Contributing

We welcome contributions to the Education System project! Whether you want to report a bug, suggest an enhancement, or contribute code, please follow our contribution guidelines.

License

This project is licensed under the MIT License.