Skip to content

mahafujul/Curobrain

Repository files navigation

Curobrain - Learning Management System

Curobrain is a comprehensive Learning Management System (LMS) developed using the MERN (MongoDB, Express, React, Node.js) stack along with TypeScript.

Overview

Curobrain is aimed at providing an efficient platform for managing online learning, offering a range of features for both educators and learners. It facilitates the creation of courses, quizzes, assignments, and interactive learning material, ensuring a seamless learning experience.

Tech Stack

  • Frontend: Built with React, leveraging TypeScript for enhanced type safety and development experience.
  • Backend: Utilizes Node.js and Express for the server-side, with MongoDB as the database for efficient data management.

Features

  • User Management: Create, manage, and authenticate users, differentiating between roles such as students, teachers, and administrators.
  • Course Creation: Allows educators to create and manage courses, including modules, lessons, and various multimedia content.
  • Assignments & Quizzes: Enables the creation and grading of assignments, quizzes, and assessments.
  • Interactive Learning: Provides a platform for interactive discussions, live sessions, and collaborative learning.
  • Progress Tracking: Monitors and displays learner progress, providing analytics and insights for both educators and learners.
  • Responsive Design: Ensures accessibility across various devices for a seamless user experience.

Installation

  1. Clone the Repository:

    git clone https://github.com/your-username/Curobrain.git
    cd Curobrain
  2. Install Dependencies:

    For both the frontend and backend, navigate to their respective directories and run:

    npm install
  3. Populate .env file

    For both the frontend and backend, navigate to the appropriate directories and using the .env.example file as a guide. Enter the appropriate credentials and paste them into the.env file:

    cp .env.example .env
  4. Transpile TS to JS

    navigate to the server's root directory and run the below command to transpile that TS code to js and obtain dist folder

    tsc
  5. Run the Application:

    • Frontend:

      ./Curobrain
      npm run dev
    • Backend:

      cd server/dist
      node index.js
  6. Access the Application:

    Open your browser and go to http://localhost:3000 to access the Curobrain LMS.

    In your case url may be different follow the instructions shown in your terminal.

Contributing

We welcome contributions to Curobrain! If you'd like to contribute, please fork the repository and create a pull request. Ensure to follow the established code style and guidelines.

Contact

For any inquiries or support related to the project, feel free to contact Mahafujul Haque.

Thank you for your interest in Curobrain - Happy Learning!

Releases

No releases published

Packages

No packages published