StudyBoat

Educate, Learn, Grow

Comment


StudyBoat - Your personal AI-Powered Study Assistant

StudyBoat is designed for users!
Explore the docs »

View Demo · Video Presentation · Report Bug · Request Feature

About The Project

StudyBoat is a personal study tool designed to help you with your educational needs.

Main Features:

  • Essay Feedback Tool

    Our essay feedback tool leverages the OpenAI GPT API to query the model and recieve immediate feedback on your essay. Then, StudyBoat displays the results intuitively on the application for users to read. The application also queries the GPT API to rewrite the portions of the essay with mistakes to improve them, serving them back to the user.

  • Flashcard Study Tool

    Our flashcard study tool also leverages the OpenAI GPT API to query the model and serve flashcards on any topic. StudyBoat dynamically renders flashcards from the queried GPT API and allows the user to flip the flashcards for answers, view more flashcards, and view the previous flashcard.

  • Notes Summarizer

    StudyBoat utilizes a custom TF-ID4 model to summarize notes based on input text. It finds the words of highest value in the text, and strings them together to build a summary.

Accomplishments

  • Deployed to production (Access at https://studyboat.netlify.app)
  • High scalability due to GPT API
  • Powerful and light notes generating AI/Machine Learning Model

Built With

  • flask
  • flask

Getting Started

Get started with Study Boat

Prerequisites

First install node.

  • npm sh npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get a free API Key at https://openai.com/blog/openai-api
  2. Clone the repo sh git clone https://github.com/Rohit-K814307/StudyBoat.git
  3. Install NPM packages sh npm install
  4. Install python requirements sh pip install -r requirements.txt

Usage

Roadmap

  • [x] Build Flask API
  • [x] Build Frontend-basic
  • [x] Deploy API to Render
  • [x] Deploy Frontend-basic to Github Pages
  • [ ] Further enhancements
    • [ ] UI
    • [ ] Better Model

See the open issues for a full list of proposed features (and known issues).

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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.txt in the Github repository for more information.

Contact

Share this project:

Updates