Project IGNITE

A Learning Management System (LMS) designed for programmers. Made using Node.js, Express.js, React.js, and MongoDB.

Table of Contents

• Demo
  • Screenshots
• Features
• Technologies Used
• Running the Project Locally

Demo

You can check out the live demo of Project IGNITE here.

Screenshots

Features

• Access, create, update, and delete learning resources like articles, questions, courses
• User authentication and role-based access to certain features
  • Login using Access Tokens
• Images crop and upload
• Markdown Editor and Markdown Viewer
• Video Player

Technologies Used

Frontend

• React
• TailwindCSS for styling
• Axios
• Redux Toolkit (RTK)
• Redux Persist
• React MD Editor
• React Cropper

Backend

• Express.js
• Node.js
• Mongoose
• JSON Web Tokens (JWT)
• Bcrypt
• Multer
• Cloudinary

Running the Project Locally

These instructions will help you set up a copy of the project on your local machine.

Prerequisites

Before getting started, make sure you have Node.js and npm (Node Package Manager) installed on your machine. This project requires Node.js version 18.15.0 or higher.

Installing & Usage

1. Clone the repository to your local machine:

   git clone https://github.com/Krishnanand2517/project-ignite

2. Navigate to the backend directory & install the project dependencies:

   cd server
   npm install

3. Copy the environment variables to a new file .env:

   cp .env.sample .env

   Obtain the values and API keys for the variables from their respective sources.

4. Once you have installed the project and its dependencies, you can run the development server:

   npm run dev

   This will start the backend server on port 3001, and you can access it in your web browser at http://localhost:3001/.

5. Navigate to the frontend directory and install project dependencies:

   cd ..
   cd frontend
   npm install

6. Run the development server for frontend:

   npm run dev

   This will start the frontend server on port 5173, and you can access the web app in your web browser at http://localhost:5173/

Contribute

If you encounter any issues, have suggestions, or want to contribute, feel free to open an issue or submit a pull request. Happy coding!