https://github.com/cybersecsi/cybertrivia
Easily create a trivia board game from a generic YAML file.
https://github.com/cybersecsi/cybertrivia
cybersecurity game trivia
Last synced: 5 months ago
JSON representation
Easily create a trivia board game from a generic YAML file.
- Host: GitHub
- URL: https://github.com/cybersecsi/cybertrivia
- Owner: cybersecsi
- License: mit
- Created: 2023-06-19T08:03:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T14:23:50.000Z (over 1 year ago)
- Last Synced: 2025-05-07T08:57:26.641Z (about 1 year ago)
- Topics: cybersecurity, game, trivia
- Language: TypeScript
- Homepage:
- Size: 232 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CyberTrivia
_CyberTrivia_ is a simple _React_ application to create a **trivia board game** from a generic _YAML_ file with the:
- questions
- answers
- points
## đ Table of Contents
- [đ Table of Contents](#-table-of-contents)
- [⥠YAML structure](#-yaml-structure)
- [âšī¸ Usage](#âšī¸-usage)
- [đ Creating a Trivia Game](#-creating-a-trivia-game)
- [đ§ Contributing](#-contributing)
- [đ Credits](#-credits)
- [đĒĒ License](#-license)
## ⥠YAML structure
The YAML file must have the following structure:
```yaml
:
- question:
-
-
-
- ...
answers:
-
-
- ...
points:
:
- question:
-
-
-
- ...
answers:
-
-
- ...
points:
```
Here is a description of these fields:
- **Category**: Represents the category of the trivia questions.
- **Question**: The trivia question itself.
- **Option**: Multiple options for the question (if applicable, leave blank otherwise).
- **Answer**: The correct answer(s) for the question.
- **Points**: The number of points awarded for answering the question correctly.
## âšī¸ Usage
To use the "Cyber Trivia" application:
1. Clone the repository:
```bash
git clone https://github.com/cybersecsi/cybertrivia.git
```
2. Install the necessary dependencies:
```bash
yarn install
```
3. Start the application:
```bash
yarn dev
```
4. Access the application in your web browser at http://localhost:5173
### đ Creating a Trivia Game
1. Prepare a YAML file following the structure mentioned above.
2. In the application, click on the "Nuova Partita" button.
3. Drag & Drop the YAML file.
4. Enjoy the game!
## đ§ Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
When contributing to this repository, please follow the existing code style, conventions, and Git workflow.
## đ Credits
Developed by Angelo Delicato [@SecSI](https://secsi.io)
## đĒĒ License
This project is licensed under the [MIT License](https://github.com/cybersecsi/cybertrivia/blob/main/LICENSE).