https://github.com/gnaaruag/lms-app
A learning Management System built on Node, Postgres
https://github.com/gnaaruag/lms-app
ejs-express expressjs jest-test nodejs postgresql sequelize
Last synced: 2 months ago
JSON representation
A learning Management System built on Node, Postgres
- Host: GitHub
- URL: https://github.com/gnaaruag/lms-app
- Owner: gnaaruag
- Created: 2024-01-05T08:58:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T08:20:51.000Z (over 2 years ago)
- Last Synced: 2025-06-27T10:11:25.951Z (12 months ago)
- Topics: ejs-express, expressjs, jest-test, nodejs, postgresql, sequelize
- Language: EJS
- Homepage: https://lms-app-kl6p.onrender.com/
- Size: 1.33 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lms-project
This is a Learning Management System project
Students can register for courses, and learn and complete courses.
Educators can create a course and have students enrol in them
Each Course has Chapters
Each Chapter can have multiple Modules(smaller Sections in a Chapter)
Each Module has pages which can be read by the user and marked as complete
Each page can have content in it and along with it have code blocks, blockquotes, images, links etc.
- [Installation](#installation)
- [Features](#features)
- [User Flow Diagram](#userflow)
- [Database Schema](#database-schema)
- [Technologies Used](#technologies-used)
## Installation
To get started with this project
1. Clone the repository:
```
https://github.com/gnaaruag/lms-project.git
```
2. Navigate to the project directory:
```
cd lms-project
```
3. Install dependencies:
```
npm install
```
4. Set up the Database
```
npx sequelize-cli db:migrate
```
5. Start the Application
```
npm start
```
## Features
#### User Authentication:
User registration and login.
Differentiation between student and educator accounts.
Password hashing for security.
#### Course Management:
Creation of courses by educators.
Display of course details, including name, duration, and description.
#### Chapter and Module Creation:
Addition of chapters within a course.
Creation of modules within each chapter.
#### Page and Content Management:
Creation of pages for modules.
Addition of educational content to pages.
#### Enrollment and Registration:
Students can enroll in courses.
Tracking of course enrollment status.
#### Dashboard:
Display of relevant information upon user login.
Overview of enrolled courses for students.
Overview of created courses for educators.
#### Middleware for Access Control:
Implementation of middleware to check user access levels.
Authorization checks for certain routes.
#### Course Analytics:
View analytics for each course.
Display the number of students enrolled in each course.
#### Password Update:
Ability for users to update their passwords securely.
#### Student Course Overview:
Presentation of a student's enrolled courses with details.
Chapter Overview:
#### Educator Analytics:
Analytics for educators to track the number of students enrolled in their courses.
## Userflow
Below is a userflow diagram I sketched at the start of the project
## Database Schema
Below is the database Schema I have used
## Technologies Used
### Frontend
##### HTML/CSS/JavaScript:
- The core building blocks for the user interface and interactivity.
##### Tailwind CSS:
- A utility-first CSS framework used for styling components.
##### EJS (Embedded JavaScript):
- A template engine for rendering dynamic content on the server side.
### Backend
##### Node.js:
- A JavaScript runtime used for building scalable network applications.
##### Express.js:
- A web application framework for Node.js, facilitating the creation of robust APIs and web applications.
##### Passport.js:
- A middleware for user authentication.
##### Sequelize:
- A promise-based Node.js ORM for PostgreSQL, MySQL, MariaDB, SQLite, and Microsoft SQL Server.
### Database
##### PostgreSQL:
An open-source relational database management system used to store application data.
### Testing
##### Jest:
- A JavaScript testing framework for unit testing.
##### Supertest:
- A library for HTTP assertions and testing HTTP servers.
## Application Screenshots
