- Introduction
- Built With
- Main Components
- Deploy Locally with NPM
- Deployment
- Illustrations
- Roadmap
- Authors & Acknowledgments
- License
Brain Busters is a trivia game designed to entertain and educate players on a wide range of topics, from history and geography to pop culture and sports. It provides a solution to the problem of limited entertainment and educational options for people seeking to learn, have fun, connect with others, and maybe even discover new interests.
The game stands out for its various game modes. The classic trivia game offers a traditional style of gameplay, while the image mode gradually reveals blurry pictures. Both modes challenge players on quick decision-making. The facts are accessed and updated using an API, keeping the game up-to-date and accurate.
Next to the single mode, the duel mode adds an exciting element of competition, allowing players to challenge other users, creating a more dynamic and engaging experience, as players can track their progress and compete for the ultimate title of Brain Busters champion.
- React - Front-end JavaScript library
- NPM - Build automation tool
- STOMP - Bidirectional real time communication
The Home file handles the start-up of a game and guides the user to the start of a game. This entails the logic of the game and player modes and handling of the users, which makes it connected to the ReceiveInvitation/ChallengePlayer component.
The ReceiveInvitation file handles the invitation mechanism of the application, this is a critical part of being able to play the game in duel mode. Additionally, it supplements the ChallengePlayer file.
The ChallengePlayer file handles the system of who can be invited. A crucial point to mention is that online users already in a game, cannot be invited.
The GameHeader file lets the user know important information such as the state of the game (Single vs. Duel, Trivia vs. Image Mode) as well as the number of questions asked. In addition, it handles an important aspect of the game logic, which is the "Cancel Game" function. Any user has to option of cancelling a game at any point in time.
The GameScreen file contains a large amount of the game logic and sequence. It draws questions and gets the answers of both the trivia and image mode to the user. In addition, there is a large logic in terms of timers, which benefits the user experience immensely.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Clone the client-repository onto your local machine with the help of Git.
git clone https://github.com/sopra-fs23-group-10/sopra-fs23-group-10-client.gitFor your local development environment, you will need Node.js. You can download it here.
npm installClient should be up and running on localhost:3000.
npm run devnpm run build- the main branch is automatically mirrored onto Google Cloud App Engine via GitHub workflow
- Google SQL PostgreSQL instance is hosted on Google Cloud
- Credentials for Google App Engine and SQL instances are replaced with GitHub Secrets
Features that new developers who want to contribute to our project could add.
- new game modes, e.g. a music quiz
- convert to iOS & Android native app
- increase responsiveness for mobile browsers
- add new records to our image database
- Sarah Egger - Frontend - saeie07
- Linn Spitz - Frontend - ringdinglinn
- Patrick Widmer - Backend - Chopstew
- Sandrin Hunkeler - Backend - Altishofer
- Cédric Lüchinger - Backend - dattes
We would like to thank our tutor jemaie and the whole team of the module Software Engineering Lab from the University of Zurich.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.