ClassBuddy

“Online learning is rapidly becoming one of the most cost-effective ways to educate the world’s rapidly expanding workforce.” - Jack Messman

Table of Contents

1. About The Project
   • Key Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Built for inspiration Hackathon 2021, ClassBuddy is an Advance Note Taking app which connects to your Google Classroom and fetches data of all the classes you have enrolled in along with lecture details and study Material. Our Text editor and web scraper let you create notes for lectures with the help of reference material in the form of open-source projects, book recommendations, research papers, and Google Classroom Notes. Notes created by users can be saved and later queried using our notes search feature powered by Algolia.

---

Key Features

Seemless Integration with Google Classroom

Get all the classes you’ve registered for in Google Classroom without any hassle.

Feature Rich Notes Taker & Web Scraper

Feature Rich text edittor with lecture related web suggestions which let you take notes on the go. Get all Notes shared in Google Classroom along with research papers, github projects and book recommendations from our web scrapper.

Notes Search

Search though all the notes you created using our custom search powered by Algolia.

Built With

• Express
• MongoDb
• React
• Nodejs
• AntDesign

Getting Started

To get a local copy up and running follow these simple example steps:

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get API keys, credentials as mentioned in the env_example files
2. Clone the repo

   git clone https://github.com/InspirusDBCE/AlphaQ_Inspirus2021.git

3. Installing and running the frontend

   cd frontend
   npm install
   npm start

4. Installing and running the backend

   cd backend
   nodemon server.js

Screenshots

The working parts are as follows:

1. The landing page:
   
   
   
   
2. A page to display courses
   
   
3. A page built with an in house editor
   
   
   
   

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.