Giter Club home page Giter Club logo

cue's Introduction

Cue banner

Study with AI-powered Active Recall

Learn More · Docs · Live Beta (limited) · Contributing


Features

  • Converts notes into Active Recall questions
  • Currently supports text pasting, with Google Docs and Notion coming soon™

Stack

Contributing

Contributions are welcome and much appreciated! Please see CONTRIBUTING.md for more details.

Getting set up

Setting up your own instance of Cue can be done in a few steps. We're working on simplifying this process, and are open to suggestions.

First, clone the repo. Then, create a .env.development.local file with the following keys:

# NextAuth
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET // generate with `openssl rand -base64 32`

# Google OAuth
GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET

# OpenAI
OPENAI_API_KEY

# Vercel KV
KV_URL
KV_REST_API_URL
KV_REST_API_TOKEN
KV_REST_API_READ_ONLY_TOKEN

This will require you to create your own Google OAuth app, generate your own OpenAI API key, and set up your own Vercel KV database.

When you're ready, run npm run dev to start the development server.

Your instance of Cue should now be running on localhost:3000.

cue's People

Contributors

edwardshturman avatar sanjanarattan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

cue's Issues

Notion integration

Takes the form of an embed and OAuth integration

Early ideas:

  1. Student adds embed of a personalized link to what renders as a "Generate cues" button
  • Might look like https://cue.study/notion?token={their_own_key}&pageId={the_id_part_of_the_notion_link_to_their_notes}
    • Token generated via Unkey
  1. Student writes their notes as usual
  2. Clicking the button fetches the page content via Notion API and sends it to Cue endpoint to generate cues
  3. Question/answer pairs get added to bottom of Notion page and/or shows up in the app since they clicked the button link

Onboarding

  • What do you study at {school}?
    • Pull from email address

other qs...

Auth policies

This issue tracks progress on handling levels of access (invited students → all USF students → all students with an .edu email address → public access).

API safety

Increasing the safety behind cue generation and interaction with the OpenAI API:

Restyle

  • Embrace cute vibe
  • Find a good variable handwritten font lol
  • Rive?
  • shadcn/ui for more accessible & reliable components

Invite system

In 64782a0 (#10) I disabled the invite button, which was linked to a Typeform popup. Seeing as invites aren't that high on the priority list for getting Cue out there (see here), this'll be down the line. Might come back to Typeform but most likely will be a custom solution of ours.

In-app roadmap

  • Simple modal with info on what we're working on now, and what's right up next
  • Dynamically fetches from GitHub based on labels search param
  • Includes a link to the repo for the curious ones
image

Vercel AI SDK

Abstracts a lot of the utils, plus will enable swapping out models if needed in the future.

Cue generation history and export

  • Saving up to 100 question-answer pairs, letting student delete or select for export
  • Export should have compatibility for Quizlet and Anki

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.