https://github.com/chrispsang/learnhub

LearnHub is a comprehensive online learning platform designed to enhance user engagement and motivation. Built using a modern tech stack that includes TypeScript, Node.js, Express, React, and PostgreSQL, LearnHub offers a seamless and interactive learning experience.
https://github.com/chrispsang/learnhub

expressjs nodejs online-learning postgresql-database sequelize typescript-react

Last synced: 15 days ago
JSON representation

LearnHub is a comprehensive online learning platform designed to enhance user engagement and motivation. Built using a modern tech stack that includes TypeScript, Node.js, Express, React, and PostgreSQL, LearnHub offers a seamless and interactive learning experience.

• Host: GitHub
• URL: https://github.com/chrispsang/learnhub
• Owner: chrispsang
• Created: 2024-07-13T18:03:16.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T03:12:54.000Z (4 months ago)
• Last Synced: 2024-11-06T17:14:48.450Z (2 months ago)
• Topics: expressjs, nodejs, online-learning, postgresql-database, sequelize, typescript-react
• Language: TypeScript
• Homepage:
• Size: 285 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
LearnHub


LearnHub is a comprehensive online learning platform designed to enhance user engagement and motivation. Users have acccess to courses, take quizzes, track their progress, participate in discussion forums, and leave reviews and ratings. The platform is built using TypeScript, Node.js, Express, React, and PostgreSQL.

## Table of Contents

- [Features](#features)

- [Tech Stack](#tech-stack)

- [Installation](#installation)

## Features

- **User Authentication:** Secure authentication system for user registration, login, and logout to protect user data and ensure privacy.

- **Courses and Quizzes:** Users have access to a variety of courses, each with interactive quizzes that can be attempted multiple times to improve learning outcomes.

- **Progress Tracking:** Display quiz progress, including scores and completion status, to help users monitor their learning journey.

- **Leaderboards:** Boost motivation with leaderboards that display top performers, encouraging a competitive yet fun learning environment.

- **Discussion Forums:** Engage with other learners through topic-based discussion forums to ask questions, share knowledge, and collaborate.

- **Reviews and Ratings:** Provide valuable feedback by leaving reviews and ratings for courses, helping other users make informed decisions.

## Tech Stack

[![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white)](https://reactjs.org/) 

[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)

[![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/) 

[![Express](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white)](https://expressjs.com/) 

[![Sequelize](https://img.shields.io/badge/Sequelize-52B0E7?style=for-the-badge&logo=sequelize&logoColor=white)](https://sequelize.org/)

[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?style=for-the-badge&logo=postgresql&logoColor=white)](https://www.postgresql.org/)

## Installation

### Prerequisites

- [Node.js](https://nodejs.org/) (v14 or higher)

- [PostgreSQL](https://www.postgresql.org/) (v12 or higher)

- [npm](https://www.npmjs.com/)

### Setup

1. **Clone the repository:**

    ```bash

    git clone https://github.com/chrispsang/LearnHub.git

    cd LearnHub

    ```

2. **Install backend dependencies:**

    ```bash

    npm install

    ```

3. **Install frontend dependencies:**

    ```bash

    cd online-learning-platform-frontend

    npm install

    cd ..

    ```

### Database Setup

1. **Start the PostgreSQL service:**

    - **Linux:**

      ```bash

      sudo service postgresql start

      ```

    - **macOS with Homebrew:**

      ```bash

      brew services start postgresql

      ```

    - **Windows:**

      ```cmd

      net start postgresql

      ```

2. **Access the PostgreSQL command line:**

    - **Linux:**

      ```bash

      sudo -u postgres psql

      ```

    - **macOS with Homebrew:**

      ```bash

      psql postgres

      ```

    - **Windows:**

      ```cmd

      psql -U postgres

      ```

3. **Create a superuser in PostgreSQL:**

    ```sql

    CREATE USER myuser WITH SUPERUSER PASSWORD 'mypassword';

    ```

4. **Create the database:**

    ```bash

    psql -U myuser -d postgres -c "CREATE DATABASE online_learning_platform OWNER myuser;"

    ```

5. **Grant all privileges to the user:**

    ```bash

    psql -U myuser -d postgres -c "GRANT ALL PRIVILEGES ON DATABASE online_learning_platform TO myuser;"

    ```

6. **Verify the creation:**

    ```bash

    psql -U myuser -l

    ```

### Running Migrations and Seeders

1. **Run the Sequelize migrations to set up the database schema:**

    ```bash

    npx sequelize-cli db:migrate

    ```

2. **Seed the database with initial data:**

    ```bash

    npx sequelize-cli db:seed:all

    ```

### Starting the Development Servers

1. **Start the backend server (runs on http://localhost:5001):**

    ```bash

    npm start

    ```

2. **Start the frontend development server (runs on http://localhost:3000):**

    ```bash

    cd online-learning-platform-frontend

    npm start

    ```