https://github.com/compsigh/cue
Study with AI-powered Active Recall
https://github.com/compsigh/cue
active-recall mongodb nextjs openai react studying vercel
Last synced: about 1 month ago
JSON representation
Study with AI-powered Active Recall
- Host: GitHub
- URL: https://github.com/compsigh/cue
- Owner: compsigh
- Created: 2023-04-01T01:37:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T00:53:48.000Z (over 1 year ago)
- Last Synced: 2024-01-20T09:33:47.829Z (over 1 year ago)
- Topics: active-recall, mongodb, nextjs, openai, react, studying, vercel
- Language: TypeScript
- Homepage: https://cue.study
- Size: 112 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
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
- [React](https://react.dev)
- [Next.js](https://nextjs.org)
- [Sass](https://sass-lang.com)
- [NextAuth.js](https://github.com/nextauthjs/next-auth)
- [Vercel KV](https://vercel.com/docs/storage/vercel-kv)
- [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions)
## Contributing
Contributions are welcome and much appreciated! Please see [CONTRIBUTING.md](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:
```text
# 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](http://localhost:3000/).
