StudyBuddy

StudyBuddy is here to help you ace your exams. Give it a pdf copy of your lectures and it'll write up questions for you to practice on.

The devpost for the project can be seen here.

Requirements

• ruby

• node

• yarn

  npm i -g yarn

Getting started

• Install dependencies

  bundle install
  yarn install

• Run missing database migrations

  bin/rails db:migrate

• Run tailwind watcher

  bin/rails tailwindcss:watch

• Create a credentials file to hold required keys for development

  EDITOR="vim" bin/rails credentials:edit --environment development

• Run server

  bin/rails s

Secrets

• Retrieve your OpenAI API key here and copy it to your clipboard

• Ensure the contents of the file opened by the above command include the following

  openai:
    access_token: "insert-key-here"