Skip to content

Latest commit

 

History

History
105 lines (78 loc) · 3.77 KB

README.md

File metadata and controls

105 lines (78 loc) · 3.77 KB
Raw

Ride-Hack-24

Welcome to the Project 'LearnHub' ! Our website is a one-stop solution catering to the educational needs of underprivileged students in grades 6 to 10. We facilitate book donations, offer study materials, including NCERT books, and provide customized video tutorials to address individual doubts along with doubt engine to solve doubts. We also provide a features in which peers can connect ,via video calling, on our platform to discuss their doubts and study together. Our platform also features quizzes to further enrich the learning journey for these students.

Table of Contents

  • Introduction
  • Features
  • Tech Stacks
  • Installation
  • Contributing

Features

  • Study Materials: We provide books for class 6 to class 10 at one place which is tiring to find on NCERT Website.

  • Videos: By using Youtube API, user can search any related video they want to study so that the recommendations of youtube get avoided.

  • Quizzes: We will be providing quizzes to the users along with thier personal dashboard so that they can test and analyze their knowledge.

  • Doubt Engine: We have provided a Bot Feature in which user can input any type of doubt and will get the answer instantly.

  • Scholarships: We have provided various scholarship information provided by the Goverment so that the needy can get much needed education without taking tension of monetary expenses.

  • Book Donation: We have provided a feature in which any user can donate the books which are no use of them but would be very helfpul for the needy who are willing to study.

  • Video Calling: We have provided a feature in which peers can video call among themselves to study together and solve doubts together.

Tech Stacks

  • Frontend:

    • ReactJS
    • CSS

  • Backend:

    • Node.js (Express)
    • Postgre SQL

Installation

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

clone this repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

copy URL to clipboard

For example:

git clone https://github.com/your-name/Ride-Hack-24.git

where your-name is your GitHub username. Here you're copying the contents of the our repository from GitHub to your computer.

To Run the Website

Your System must have

  • Node.JS
  • Postgre SQL

To Run Frontend:

Navigate to client repository:

cd client

Run the following command to download the required modules

npm i

After that run the following to host the website on local server http://localhost:3000/

npm start

To Run the BackEnd

Open a New Terminal and Navigate to server repository:

cd server

Run the following command to download the required modules

npm i

After that run the following to host run the backend on local server http://localhost:5000/ and http://localhost:5432/

nodemon index.js

If in your system, the above command doesn't work, run the following command

node index.js

Now You Are all Set to Use Our Website. Enjoy !!

Contributing

Contributions are Welcome! If you'd like to contribute to the project, please follow the General Contribution Guidelines.