https://github.com/henriqueweiand/quiz-english
Unleash your inner brainiac with Quiz-English! Our clever AI gathers real-world knowledge from news, videos, podcasts, and more, crafting quizzes that challenge and intrigue history buffs, science geeks, and anyone who loves learning something new.
https://github.com/henriqueweiand/quiz-english
neondb nextjs openai postgresql shadcn-ui trivia-quiz-game
Last synced: 6 months ago
JSON representation
Unleash your inner brainiac with Quiz-English! Our clever AI gathers real-world knowledge from news, videos, podcasts, and more, crafting quizzes that challenge and intrigue history buffs, science geeks, and anyone who loves learning something new.
- Host: GitHub
- URL: https://github.com/henriqueweiand/quiz-english
- Owner: henriqueweiand
- License: mit
- Created: 2023-12-07T20:54:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T17:58:55.000Z (over 1 year ago)
- Last Synced: 2025-03-22T18:39:16.748Z (over 1 year ago)
- Topics: neondb, nextjs, openai, postgresql, shadcn-ui, trivia-quiz-game
- Language: TypeScript
- Homepage: https://quiz-english.app
- Size: 470 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Quiz-English
Elevate Your English on the way to Fluency!.
## Introduction
Quiz-English is your one-stop shop for trivia and quizzes that are smarter than your average brainteaser. Our AI curates questions from the real world, pulling from news , videos , blog posts ️, articles , podcasts , and more!
Whether you're a history buff , a science geek , or just love learning new stuff , Quiz-English has something to challenge your mind and keep you entertained! ✨
#### Ready to join the fun? Head over to Quiz-English now and see what awaits!
## Why
English learners, built this by English learners, for YOU! Quiz-English was born from the real struggles we faced learning English. We wanted a fun and engaging way to practice all your skills, especially reading and comprehension. That's why we created quizzes based on interesting topics you'll actually care about, like news, videos, and more!
## Local set up
Install one of the components from your command line.
#### Install dependencies
```sh
npm install
```
#### With npm
Copy .env.example to .env and fill the variables
```sh
DATABASE_URL="postgresql://docker:docker@localhost:5432/project?schema=public"
OPENAI_API_KEY=
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
```
You will need to have keys for all these tools listed above, but, you can do it for free.
#### Running docker
I strong suggest to run docker locally. By executing the command you can use the exacly DATABASE_URL set before.
```sh
docker-compose up -d
```
and with the database up, you need to run the migrations
```sh
yarn prisma migrate dev
```
## Contributing
- [Contribution Guide](https://github.com/henriqueweiand/quiz-english/blob/main/CONTRIBUTING.md)
## Authors
- Henrique Weiand ([@hweiand](https://github.com/henriqueweiand))
## License
MIT License