README.md

quizzy

Quizzy is a Python Flask-based multiplayer quiz web app ready to run in container mode for reliable, streamlined deployment locally or a cloud provider such as AWS.

Table of Contents

• Installation
• Usage
• Notes over structure
• Contributing
• License

Installation

To install quizzy locally in dev environment:

1. Install Python & Pipenv

   Excellent instructions for installing Python on various operating systems available at:
   https://realpython.com/courses/installing-python-windows-macos-linux/

   Once Python is installed, we recommend installing Pipenv using pip:

   $ pip install --user pipenv

2. To enter the virtual environment

   $ pipenv shell

3. Install the required dependencies:

   $ pipenv install -r requirements.txt

4. Create a .env file in the quizzy directory and add a variable "SECRET_KEY" with your random token as a the value.

   SECRET_KEY=<YOUR RANDOM TOKEN HERE>
   

5. Start the server with the following command:

   $ python3 wsgi.py

To install and run quizzy containers in production mode using Docker:

1. Install Docker

2. Run docker-compose up from the parent project directory:

   $ sudo docker-compose up

3. To stop run docker-compose down:

   $ sudo docker-compose down

Usage

While in dev testing, naviate your browser to the localhost port 6002 (i.e. http://localhost:6002)

In production mode, navigate your browser to server IP address (i.e. http://192.168.1.10)

quizzy_screencast.mp4

Notes over structure

Contributing

Please open an issue to suggest fixes or ideas for improving quizzy.

License

The GNU General Public License v3.0