Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the README #297

Merged
merged 1 commit into from
Apr 27, 2024
Merged

Updated the README #297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# 🧠🤔 KiWiq 🥝❓📚
Visit our page [here!!!](http://kiwiq.run.place/).

WIQ is a quiz game project inspired by the engaging and thought-provoking show "Saber y Ganar."
KiWiq is a quiz game project inspired by the engaging and thought-provoking show "Saber y Ganar."
We aim to create a platform that not only challenges your knowledge but also sparks curiosity and the thrill of discovery.


## What Sets WIQ Apart
🤔 Thoughtful Questions: Dive into a world of intriguing and diverse questions, all generated procedurally using WikiData.
🌐 Encourage to improve: WIQ lets you keep track of your score to see in which areas you need to improve.
🤔 Thoughtful Questions: Dive into a world of intriguing and diverse questions, all generated procedurally using WikiData.

😭 It works! after the final version final re-final (FINAL) true (final) (hotfix)
🌐 Encourage to improve: KiWiq lets you keep track of your score to motivate you into learning more.

## Features
🏆 Adaptable difficulty: You can adjust the difficulty to push your limits.
🔣 Question diversity: KiWiq offers you a variety of questions so you can test your knowledge in a variety of fields.

🌐 Multiplayer: Compete with friends and strangers to prove you are the best.
## Features
🏆 Adaptable difficulty: You can adjust the difficulty to push your limits.

🌐 Localized: Available in Spanish and English.
🌍 Localized: Available in Spanish and English.

## Contributors
Contributor | Contact
Expand All @@ -43,7 +42,7 @@ This repo is a basic application composed of several components.
Component | Route | Description
-- | -- | --
Backend/API | `api/` | The main backend service, implemented in Java SpringBoot. It serves all requests from the frontend, and it doubles as main API. It also has a JWT-based authentication system.
Question generator | `questiongenerator/` | A SpringBoot-based service, ran alongside the main backend service, that generates questions and inserts them into the database
Question generator | `questiongenerator/` | A Java program that generates questions and inserts them into the database, from where they are fetched by the API.
Webapp | `webapp/` | Our own frontend to the backend. It is implemented in React 18.

***
Expand Down