Skip to content

Dhaval2908/RockLearn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Learning Center

Project Overview

The Learning Center is a web-based platform designed to host and manage educational labs. It provides a user-friendly interface for learners to browse, interact with, and complete labs while enabling administrators to create and manage labs using a simple Git-based workflow.


Setup and Installation

To set up and run the project, follow these steps:

1. Clone the Repository

Run the following command to clone the project repository:

git clone https://github.com/Dhaval2908/RockLearn

2. Navigate to the Project Directory

After cloning the repository, navigate to the project folder:

cd RockLearn

3. Install Dependencies

Frontend:

Navigate to the Frontend folder and install the required dependencies:

cd Frontend  
npm install

Backend:

Navigate to the Backend folder and install the required dependencies:

cd Backend  
npm install

4. Configure Environment Variables

Inside the Backend folder, create a .env file and add the following variables:

DB_LINK=your-mongodb-connection-string  
BRANCH=main 
GITHUB_UNAME=your-github-username  
GITHUB_TOKEN=your-github-token  
GITHUB_USERNAME=your-github-username  
GITHUB_API_URL=https://api.github.com  
JWT_SECRET=your-jwt-secret  
JWT_EXPIRE=1d  
JWT_COOKIE_EXPIRES=7  
GMAIL_USER=your-gmail-address  
GMAIL_PASS=your-gmail-password  
CLIENT_LINK=http://localhost:5173

5. Run the Application

Frontend:

Navigate to the Frontend folder (if not already there) and start the frontend server:

cd Frontend  
npm run dev

Backend:

Navigate to the Backend folder (if not already there) and start the backend server:

cd Backend  
node index.js

6. Access the Application

Once both the frontend and backend servers are running, open your browser and navigate to the frontend URL (default: http://localhost:5173) to access the Learning Center.


Technologies Used

  • Frontend: ReactJS, Material-UI, Tailwind CSS
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Authentication: JSON Web Tokens (JWT)
  • Version Control: Git, GitHub

Contribution Guidelines

  • Fork the repository and create a new branch for your feature or bug fix.
  • Commit your changes and submit a pull request with a detailed description of your updates.

License

This project is licensed under the MIT License.


Contact

For further information or questions, contact the project team at [[email protected]].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages