https://github.com/evavic44/quiznote
An AI-powered quiz generator for creating quizes from your notes and textbooks | Powered by Google Gemini
https://github.com/evavic44/quiznote
gemini gemini-api hackathon quiz quizgenerator
Last synced: about 1 month ago
JSON representation
An AI-powered quiz generator for creating quizes from your notes and textbooks | Powered by Google Gemini
- Host: GitHub
- URL: https://github.com/evavic44/quiznote
- Owner: Evavic44
- License: mit
- Created: 2024-04-27T12:52:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-03T09:19:26.000Z (about 1 year ago)
- Last Synced: 2024-10-06T05:21:35.051Z (8 months ago)
- Topics: gemini, gemini-api, hackathon, quiz, quizgenerator
- Language: TypeScript
- Homepage: https://quiznote.vercel.app
- Size: 1.13 MB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quiznote
The ultimate learner's companior for transforming notes into interactive quizzes to help maximize learning retention
## Demo Video
[Quiznote Demo Video](https://youtu.be/ek5dUA8Db_w?si=V_9dNpyM2xk0CW5a)
## Technologies
- 🎯 [NextJS](https://nextjs.org) - UI framework
- ☑️ [Vercel](https://vercel.com) - Hosting and deployment
- 💅🏽 [TailwindCSS](https://tailwindcss.com) /CSS - Styling and UI
- 🤖 [Gemini](https://gemini.google.com) / AI API
## Run Project Locally
Follow the steps below to run quiznote locally on your machine
> [!note]
> For the Google AI Hackathon judges, please ignore the steps below and insert the `GOOGLE_SERVICE_KEY` sent via the test email into a `.env.local` file to start the program.
- `git clone https://github.com/Evavic44/quiznote`
- Rename `.env.example` to `.env.local`
- Get your private keys from [google cloud IAM & Admin](https://cloud.google.com)
- Create a project that has access to all Vertext AI resource
- Export the service account key to `JSON`
- convert the `JSON` content to `base64`
- Set the value of `GOOGLE_SERVICE_KEY` to the Base64 JSON
```bash
cd quiznote
npm install
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
### Important files and folders
| File(s) | Description |
| --------------------------------------------- | --------------------------------------------- |
| [`route.ts`](./src/app/api/generate/route.ts) | Integration file for setting up Gemini prompt |
| [`page.tsx`](./src/app/page.tsx) | Homepage route |
| [`components`](./src/components/) | Where components are stored |
| [`store`](./src/store/) | State management store |
