E-Learning Management Fullstack System

Welcome to the E-Learning Management System (LMS)! This project consists of two main components: the Frontend (built with Angular) and the Backend (developed using Django and Django REST Framework). The LMS is a full-featured web application designed to manage users, courses, lessons, quizzes, and much more. This README provides a complete guide on how to set up, run, and contribute to both parts of the system.

Project Overview
- The MAD-Stack
Features
Detailed Project Information
File Structure
Getting Started
Live Frontend Demo
API Documentation
Containerization
Troubleshooting
- Common Issues
- Debugging Tips
Additional Information
Contributing
License
Contact

Project Overview

The E-Learning Management System is a web-based platform designed to facilitate online education and training. It provides a comprehensive set of features for managing courses, lessons, users, quizzes, and more. The system is composed of:

Frontend: Built with Angular and Bootstrap, it offers a user-friendly interface for interacting with the platform.
Backend: Developed using Django and Django REST Framework, it provides robust REST APIs for all the operations.
Database: The system uses MongoDB to store data and Redis for efficient server-side caching.

Because we use MongoDB, Angular, and Django, we call this a MAD-Stack application!

The MAD-Stack

The MAD-Stack is a modern web development stack that combines the following technologies:

MongoDB: A NoSQL database used to store data.
Angular: A frontend framework for building web applications.
Django: A high-level Python web framework for backend development.

The MAD-Stack is a powerful combination that allows developers to build scalable, responsive, and feature-rich web applications. It leverages the strengths of each technology to create a seamless user experience.

Features

User Authentication: Token-based authentication for secure login.
Server-Side Caching: Redis caching for improved performance and reduced server load.
Course Management: Create, update, delete, and display courses.
Lesson Management: Manage lessons associated with courses.
Quiz Management: Handle quizzes, questions, and choices.
User Management: Administrate users, enrollments, and user roles.
Progress Tracking: Monitor and visualize user progress.
Notification System: Send and manage notifications.
Responsive Design: Optimized for all devices.
Search and Filtering: Search and filter courses and lessons.
Data Visualization: Dynamic charts using Chart.js.
Comprehensive APIs: Powerful RESTful APIs for all operations.
API Documentation: Comprehensive REST API documentation with Swagger and Redoc.

Detailed Project Information:

Frontend User Interfaces

Home Page:

Course List:

Lesson List:

User List:

Enrollment List:

Progress List:

Login Page:

Unauthorized Access (when not logged in):

Footer:

Responsive Design: The frontend is fully responsive and optimized for all devices. Here is an example of the mobile view:

And many more pages & features. Feel free to explore the frontend and backend to see all the functionalities!

Available API Endpoints

Endpoint	Method	Description
`/api/users/`	GET	Retrieve a list of all users.
`/api/users/{id}/`	GET	Retrieve a specific user instance.
`/api/users/`	POST	Create a new user instance.
`/api/users/{id}/`	PUT	Update a specific user instance.
`/api/users/{id}/`	DELETE	Delete a specific user instance.
`/api/courses/`	GET	Retrieve a list of all courses.
`/api/courses/{id}/`	GET	Retrieve a specific course instance.
`/api/courses/`	POST	Create a new course instance.
`/api/courses/{id}/`	PUT	Update a specific course instance.
`/api/courses/{id}/`	DELETE	Delete a specific course instance.
`/api/categories/`	GET	Retrieve a list of all categories.
`/api/categories/{id}/`	GET	Retrieve a specific category instance.
`/api/categories/`	POST	Create a new category instance.
`/api/categories/{id}/`	PUT	Update a specific category instance.
`/api/categories/{id}/`	DELETE	Delete a specific category instance.
`/api/lessons/`	GET	Retrieve a list of all lessons.
`/api/lessons/{id}/`	GET	Retrieve a specific lesson instance.
`/api/lessons/`	POST	Create a new lesson instance.
`/api/lessons/{id}/`	PUT	Update a specific lesson instance.
`/api/lessons/{id}/`	DELETE	Delete a specific lesson instance.
`/api/quizzes/`	GET	Retrieve a list of all quizzes.
`/api/quizzes/{id}/`	GET	Retrieve a specific quiz instance.
`/api/quizzes/`	POST	Create a new quiz instance.
`/api/quizzes/{id}/`	PUT	Update a specific quiz instance.
`/api/quizzes/{id}/`	DELETE	Delete a specific quiz instance.
`/api/questions/`	GET	Retrieve a list of all questions.
`/api/questions/{id}/`	GET	Retrieve a specific question instance.
`/api/questions/`	POST	Create a new question instance.
`/api/questions/{id}/`	PUT	Update a specific question instance.
`/api/questions/{id}/`	DELETE	Delete a specific question instance.
`/api/choices/`	GET	Retrieve a list of all choices.
`/api/choices/{id}/`	GET	Retrieve a specific choice instance.
`/api/choices/`	POST	Create a new choice instance.
`/api/choices/{id}/`	PUT	Update a specific choice instance.
`/api/choices/{id}/`	DELETE	Delete a specific choice instance.
`/api/enrollments/`	GET	Retrieve a list of all enrollments.
`/api/enrollments/{id}/`	GET	Retrieve a specific enrollment instance.
`/api/enrollments/`	POST	Create a new enrollment instance.
`/api/enrollments/{id}/`	PUT	Update a specific enrollment instance.
`/api/enrollments/{id}/`	DELETE	Delete a specific enrollment instance.
`/api/progress/`	GET	Retrieve a list of all progress records.
`/api/progress/{id}/`	GET	Retrieve a specific progress record instance.
`/api/progress/`	POST	Create a new progress record instance.
`/api/progress/{id}/`	PUT	Update a specific progress record instance.
`/api/progress/{id}/`	DELETE	Delete a specific progress record instance.
`/api/notifications/`	GET	Retrieve a list of all notifications.
`/api/notifications/{id}/`	GET	Retrieve a specific notification instance.
`/api/notifications/`	POST	Create a new notification instance.
`/api/notifications/{id}/`	PUT	Update a specific notification instance.
`/api/notifications/{id}/`	DELETE	Delete a specific notification instance.

Unit Tests for APIs

The backend includes unit tests for the APIs. You can run the tests using the following command:

python manage.py test

Feel free to view and modify the tests in the core/tests.py file. Also, be sure to adjust the URLs in the test cases to match your actual URL configuration if different from the default.

File Structure

The project structure is as follows:

Learning-Management-System/
├── LMS-Backend
│   ├── manage.py
│   ├── requirements.txt
│   ├── LICENSE
│   ├── db.sqlite3
│   ├── README.md
│   ├── LMSBackend/
│   │   ├── settings.py
│   │   ├── urls.py
│   │   ├── asgi.py
│   │   └── wsgi.py
│   ├── core/
│   │   ├── management/
│   │   │   └── commands/
│   │   │       └── seed_sample_data.py
│   │   ├── migrations/
│   │   │   └── __init__.py
│   │   ├── models.py
│   │   ├── views.py
│   │   ├── tests.py
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── serializers.py
│   │   └── urls.py
├── LMS-Frontend
│   ├── angular.json
│   ├── package.json
│   ├── README.md
│   ├── LICENSE
│   ├── app/
│   │   ├── src/
│   │   │   ├── app/
│   │   │   │   ├── auth/
│   │   │   │   │   ├── login/
│   │   │   │   │   │   ├── login.component.ts
│   │   │   │   │   │   ├── login.component.html
│   │   │   │   │   │   └── login.component.css
│   │   │   │   ├── core/
│   │   │   │   │   ├── footer/
│   │   │   │   │   │   ├── footer.component.ts
│   │   │   │   │   │   ├── footer.component.html
│   │   │   │   │   │   └── footer.component.css
│   │   │   │   │   ├── header/
│   │   │   │   │   │   ├── header.component.ts
│   │   │   │   │   │   ├── header.component.html
│   │   │   │   │   │   └── header.component.css
│   │   │   │   ├── pages/
│   │   │   │   │   ├── home/
│   │   │   │   │   │   ├── home.component.ts
│   │   │   │   │   │   ├── home.component.html
│   │   │   │   │   │   └── home.component.css
│   │   │   │   ├── components/
│   │   │   │   │   ├── course-list/
│   │   │   │   │   │   ├── course-list.component.ts
│   │   │   │   │   │   ├── course-list.component.html
│   │   │   │   │   │   └── course-list.component.css
│   │   │   │   │   ├── lesson-list/
│   │   │   │   │   │   ├── lesson-list.component.ts
│   │   │   │   │   │   ├── lesson-list.component.html
│   │   │   │   │   │   └── lesson-list.component.css
│   │   │   │   │   ├── user-list/
│   │   │   │   │   │   ├── user-list.component.ts
│   │   │   │   │   │   ├── user-list.component.html
│   │   │   │   │   │   └── user-list.component.css
│   │   │   │   │   ├── enrollment-list/
│   │   │   │   │   │   ├── enrollment-list.component.ts
│   │   │   │   │   │   ├── enrollment-list.component.html
│   │   │   │   │   │   └── enrollment-list.component.css
│   │   │   │   │   ├── progress-list/
│   │   │   │   │   │   ├── progress-list.component.ts
│   │   │   │   │   │   ├── progress-list.component.html
│   │   │   │   │   │   └── progress-list.component.css
│   │   │   │   ├── services/
│   │   │   │   │   ├── auth.interceptor.ts
│   │   │   │   │   ├── auth.service.ts
│   │   │   │   │   ├── user.service.ts
│   │   │   │   │   ├── course.service.ts
│   │   │   │   │   ├── lesson.service.ts
│   │   │   │   │   ├── enrollment.service.ts
│   │   │   │   │   └── progress.service.ts
│   │   │   │   ├── app.routes.ts
│   │   │   │   ├── app.component.ts
│   │   │   │   ├── app.config.ts
│   │   │   │   ├── app.config.service.ts
│   │   │   │   ├── app.component.html
│   │   │   │   └── app.component.css
│   │   │   ├── assets/
│   │   │   │   └── images/
│   │   │   │       └── .gitkeep
│   │   │   ├── main.ts
│   │   │   ├── styles.css
│   │   │   ├── manifest.json
│   │   │   └── index.html
│   │   ├── .editorconfig
│   │   ├── .gitignore
│   │   ├── angular.json
│   │   ├── package.json 
│   │   ├── package-lock.json
│   │   ├── tsconfig.json
│   │   ├── tsconfig.app.json
│   │   └── tsconfig.spec.json
│   ├── LICENSE
│   ├── README.md
├── .gitignore
├── LICENSE
└── README.md

Getting Started

Prerequisites

Ensure the following prerequisites are installed:

Node.js (v18.19 or later)
Angular CLI (v12 or later)
Python (v3.7 or later)
Django and Django REST Framework
MongoDB and Redis running locally or remotely

Backend Setup

Note: Before running the backend server, ensure MongoDB and Redis are running and accessible on your system. You can install MongoDB and Redis locally or use cloud services like MongoDB Atlas and Redis Cloud.

Clone the repository:

git clone https://github.com/hoangsonww/Learning-Management-System-Fullstack.git
cd Fullstack-Learning-Management-System/LMS-Backend

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows, use `.venv\Scripts\activate`

Install dependencies:
```
pip install -r requirements.txt
```
Configure MongoDB and Redis:

Ensure MongoDB and Redis are running and configured in settings.py. If not installed, follow the instructions to install them. It is very important to run MongoDB and Redis before running the backend server.

Apply migrations:

python manage.py makemigrations
python manage.py migrate

Create a superuser:
```
python manage.py createsuperuser
```
Follow the prompts to create a superuser account. Remember to note down the username and password because you will need it to authenticate when using the APIs later, as well as to access the Django admin panel.
Put the SECRET_KEY and set Debug to True in the settings.py file:
```
SECRET_KEY = 'your_secret_key_here'
DEBUG = True
```
Replace your_secret_key_here with a random string of characters. This key is used for cryptographic signing and should be kept secret. Or you can also contact me to get the secret key.
Seed the database with sample data:
```
python manage.py seed_sample_data
```

Run the backend server:

python manage.py runserver

The backend server should now be running at http://127.0.0.1:8000/. If the server is run successfully, you should see the Django REST Framework browsable API interface at http://127.0.0.1:8000, as well as the following console output:

python manage.py runserver
Successfully seeded realistic sample data
Successfully seeded realistic sample data
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
September 08, 2024 - 20:35:21
Django version 4.2.16, using settings 'LMSBackend.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

Frontend Setup

Navigate to the frontend directory:

cd Learning-Management-System/LMS-Frontend/app

Install dependencies:
```
npm install
```
Start the development server:
```
ng serve
```
Open the application in your browser:
```
http://localhost:4200
```
Test out the PWA functionality:
- Open the application in your browser.
- Click on the "Install" button in the address bar to install the PWA.
- Check the installed PWA in your system applications.
- Open the installed PWA and test its functionality.

Live Frontend Demo

You can access the live frontend demo of the Learning Management System at https://learning-management-system-fullstack.vercel.app/.

Note that the backend server is not hosted, so the data will not be fetched from the server. However, you can still interact with the frontend and view the basic user interfaces (just that features like charts, notifications, and user data will not be available).

API Documentation

Authentication

Most API endpoints require authentication. Use the /api/auth/login/ endpoint to log in and obtain an authentication token.

Log in to get a token:

curl -X POST http://127.0.0.1:8000/api/auth/login/ -H "Content-Type: application/json" -d '{
  "username": "your_username",
  "password": "your_password"
}'

Use the obtained token in the Authorization header for subsequent requests:

-H "Authorization: Token <your_token_here>"

Testing the APIs

You can test the API using curl, Postman, or Swagger UI.

Using `curl`

To test the API using curl, use the commands below. Replace <your_token_here> with the token obtained from the login endpoint.

List All Users

curl -X GET http://127.0.0.1:8000/api/users/ -H "Content-Type: application/json" -H "Authorization: Token <your_token_here>"

You should get something like this:

[
  {
    "id":"66dde39af395abfee65d1f86",
    "username":"gibsonstacey",
    "email":"[email protected]",
    "is_instructor":false,"is_student":false,
    "bio":"Consider red specific within chance fund successful out.",
    "profile_picture":"https://placekitten.com/970/531"
  }
]

Create a New Course

curl -X POST http://127.0.0.1:8000/api/courses/ -H "Content-Type: application/json" -H "Authorization: Token <your_token_here>" -d '{
  "title": "New Course",
  "description": "This is a new course description.",
  "instructor": "{user_id}",
  "category": "{category_id}",
  "price": 150.00,
  "published": true
}'

Repeat similar curl commands for other endpoints.

Using Postman

Open Postman.
Create a new request for each endpoint.
Set the method (GET, POST, PUT, DELETE) and URL (e.g., http://127.0.0.1:8000/api/users/).
Under the "Authorization" tab, choose "Bearer Token" and paste your token.
Send the request and check the response.

Using Swagger UI

Navigate to the Swagger UI at http://127.0.0.1:8000/swagger/.
Click on an endpoint to expand it.
Click the "Try it out" button.
Enter the required parameters and authentication token (Token <your_token_here>) in the "Authorization" header. Note that the token should be prefixed with Token and a space.
Click "Execute" to see the API response.
Alternatively, you can simply click the "Authorize" button in the top right corner of the page and enter your token there. This will automatically include the token in all requests. Then repeat steps 3 and 5 to test the endpoints.

Here is how the Swagger UI looks like:

Using Redoc

Navigate to the Redoc UI at http://127.0.0.1:8000/redoc/.
Click on an endpoint to expand it.
View the API documentation and test the endpoints.

Here is how the Redoc UI looks like:

Using Django REST Framework Browsable API

Choose any endpoint from the list above.
Navigate to the endpoint URL in your browser.
Log in using the superuser credentials.
You will see a browsable interface where you can view the details of the endpoint.

For example, to view the list of all lessons, go to http://127.0.0.1:8000/api/lessons/. The interface should look like this:

Well, remember to log in first before accessing the API... Don't forget to log in!

Seeding Sample Data

If you want to seed the database with realistic sample data, you can also run the seed_sample_data management command:

python manage.py seed_sample_data

This command will populate the database with randomly generated users, courses, categories, lessons, quizzes, questions, choices, enrollments, progress records, and notifications.

Note: By default, the seed_sample_data command will be executed when you run the python manage.py migrate command. If you don't want to seed the database at that time, you can disable it by setting SEED_SAMPLE_DATA_ON_MIGRATE = False in the settings.py file. Also, your data might be different from mine because the data is randomly generated.

Recommended GUI Tools

To interact with the APIs and databases more easily, you can use the following GUI tools:

MongoDB Compass: A GUI tool for MongoDB that allows you to explore and interact with your MongoDB databases. You can download it from here.
RedisInsight: A GUI tool for Redis that allows you to explore and interact with your Redis databases. You can download it from here.
Postman: A powerful GUI tool for testing APIs. You can download it from here.
Swagger UI: An interactive API documentation tool. You can access the Swagger UI at http://127.0.0.1:8000/swagger/. Ensure the server is running before accessing the UI.
Redoc: Another interactive API documentation tool. You can access the Redoc UI at http://127.0.0.1:8000/redoc/. Ensure the server is running before accessing the UI.

For example, you can use MongoDB Compass to view the data in your MongoDB database, RedisInsight to view the data in your Redis database, and Postman to test the API endpoints, like below:

Containerization

The project can be containerized using Docker. The Dockerfile and docker-compose.yml files are provided in the repository. To containerize the project, follow these steps:

Change directory into the project root:
```
cd Learning-Management-System
```
Build the Docker image:
```
docker compose up --build
```

The above command will build the Docker image and start the containers for the backend, frontend, MongoDB, and Redis. You can access the application at http://localhost:4200 and the Django REST Framework API at http://localhost:8000.

Troubleshooting

Common Issues

CORS Errors:

Ensure backend CORS settings allow requests from http://localhost:4200.

Unauthorized Access:

Confirm that tokens are stored correctly in localStorage.

API Connection:

Verify the backend server is running at http://127.0.0.1:8000.

Database Connection:

Check MongoDB and Redis are running and accessible.

Dependencies:

Ensure all required dependencies are installed, using pip install -r requirements.txt and npm install.

UI Issues:

Check the Angular console for errors and warnings. Alternatively, you can try clearing the cache using npm cache clean --force and npm install.

Debugging Tips

Use browser Developer Tools to inspect requests and console logs.
Check the network tab for failed requests.
Use console.log statements in the frontend code to debug.
Use print statements in the backend code to debug.
Check the Django console for server-side errors.
Check the Angular console for client-side errors.
Refer to the official documentation for troubleshooting tips.
Feel free to open an issue or contact me for help. Refer to the Contact section below.

Additional Information

Refer to the README files in the LMS-Backend and LMS-Frontend directories for more detailed information on each part of the system.

These README files contain additional information on how to run, test, and contribute to the project.

Contributing

We welcome contributions! Feel free to submit issues and create pull requests.

Fork the repository.
Clone the forked repository to your local machine.
Create a new branch and make your changes.
Commit your changes and push them to your fork.
Create a pull request to the main repository.
I will review your changes and merge them if they are accepted.

License

This project is licensed under the MIT License.

Contact

If you have any questions or need further assistance, contact us at [email protected].

Alternatively, you can also open an issue in the repository here.

⬆ Back to Top

Related Projects

Employee-Management-Fullstack-App

👥 This repository hosts the Employee Management Full-Stack App, built with a modern React fronten...

30 Aug 2024 14

Synthetic-Biology-LIMS

(In development) Microservices full-stack single-page web app built with Typescript, React, Redux...

14 Jun 2021 8

nodejs-backend-architecture-typescript

Node.js Backend Architecture Typescript - Learn to build a backend server for production ready bl...

23 Mar 2020 2,741

Learning-Management-System-Fullstack