Qwiz

An Open Source Live Quiz Platform

View Live · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Qwiz is a web app built on laravel that allows pub style quizzes. After the UK doing into lockdown on 23rd March 2020, the need for virtual pub style quizzes grew within my social circles, to the point where pen and paper no longer cut it. This is my attempt at keeping people connected.

Built With

• Laravel ❤️❤️
• Bootstrap
• JQuery

Want to host your own Qwiz server?

Getting Started

The simple steps below will get you up and running with your own quizzes in no time.

Installation

1. Clone the repo

git clone https://github.com/ThomasJones4/lockdownquiz.git

2. Install NPM packages

npm install

3. Install Composer packages

composer install

4. Create a fresh .env file

cp .env.example .env

5. Generate an encryption key

php artisan key:generate

6. Add database credentials and update .env file

DB_CONNECTION=mysql
DB_HOST=
DB_PORT=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

7. Migrate the database

php artisan migrate

8. Create an AWS S3 bucket and update .env file

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=
AWS_BUCKET=
AWS_URL=

Usage

Once a quiz has been created a user can create their own quiz, either from their own question or by using the random question genarator.

Participants can join by following a quiz masters join link both /join/{your quiz id} and /🎲/{your quiz id}. Once logged in or registered, they can join by using the 8 digit code from the quiz master (keep this secret as it prevents unwanted guests).

Every quiz must end with a results screen to allow the quiz master to mark the answers, however the quiz master can add breaks at any point though out the quiz (15 questions in? 👀🍻) and mark the question so far.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Thomas Jones - LinkedIn - thomasj2015@outlook.com

Project Link: https://github.com/ThomasJones4/lockdownquiz

Acknowledgements

• OpenTDB by PIXELTAIL GAME LLC. Used under licence CC BY 4.0
• Img Shields
• Font Awesome
• Argon
• Laravel Dusk