https://github.com/simran1002/e-learning-management-system
This backend API provides endpoints for user registration, user profile management, course management, user enrollment, and more.
https://github.com/simran1002/e-learning-management-system
Last synced: over 1 year ago
JSON representation
This backend API provides endpoints for user registration, user profile management, course management, user enrollment, and more.
- Host: GitHub
- URL: https://github.com/simran1002/e-learning-management-system
- Owner: simran1002
- Created: 2024-04-09T19:56:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T17:54:28.000Z (about 2 years ago)
- Last Synced: 2025-01-21T13:51:49.244Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# E-Learning Platform Backend
Welcome to the backend repository for our e-learning platform! This backend API provides endpoints for user registration, user profile management, course management, user enrollment, and more.
## Setup Instructions
### Prerequisites
- Node.js and npm installed on your machine
- MongoDB installed and running on your local machine
- Access to a mailing service like [resend.com](https://resend.com) for email communication
### Installation
1. Clone this repository to your local machine:
git clone https://github.com/simran1002/E-Learning-Management-System.git
2. Navigate to the project directory:
cd e-learning-backend
3. Install dependencies using npm:
npm install
### Configuration
1. Set up your local MongoDB database:
- Start MongoDB service on your machine.
2. Set up environment variables:
- Create a `.env` file in the project root.
- Add the following environment variables to the `.env` file:
```
PORT=3000
MONGODB_URI=mongodb://localhost:27017/e_learning
```
Replace `mongodb://localhost:27017/e_learning` with your actual MongoDB connection URI.
### Running the Server
1. Start the server:
npm start
### Testing Endpoints
You can test the provided endpoints using the following routes:
- User Registration: `POST /api/users/register`
- User Profile Management: `GET /api/users/:userId`, `PUT /api/users/:userId`
- Course Management: `GET /api/courses`, `POST /api/courses`, `GET /api/courses/:courseId`, `PUT /api/courses/:courseId`, `DELETE /api/courses/:courseId`
- User Enrollment: `POST /api/courses/:courseId/enroll`, `GET /api/users/:userId/courses/enrolled`
- Filtering and Pagination: `GET /api/courses?category=categoryValue&level=levelValue&page=pageNumber&limit=pageSize`
- Email Integration: Not applicable for direct testing, involves email communication