Capital Quest

Test your knowledge of world capitals with this interactive quiz game!
· Play here ·

Table of Contents 📙

• Play the Game
• Installation for Developers
  • Prerequisites
  • Option 1: Git Clone
  • Option 2: Docker

Play the Game 🌍

Play Capital Quest here

Installation for Developers 🛠️

If you want to run Capital Quest locally, follow these steps:

Prerequisites

• Python 3.10 or higher
• Git

Option 1: Git Clone 🐙

1. Clone the repository:

   git clone https://github.com/VictorGoubet/capitalquest.git
   cd capitalquest

2. Install dependencies:

   pip install -r requirements.txt

3. Run the application:

   python launch.py

   This will start both the API and front-end components in development mode.

   Customize with options:

   • --env: Choose between dev (default) or prod environments
   • --component: Run api, front, or both (default) components
   • --api-host, --api-port: Set custom API host/port (default: localhost:8000)
   • --front-host, --front-port: Set custom front-end host/port (default: localhost:8051)

   Example:

   python launch.py --env prod --component api --api-port 8080

   Note: You can also set these options using environment variables or a .env file:

   export api_host=localhost
   export api_port=8000
   export front_host=localhost
   export front_port=8051
   export environment=dev

4. Open your browser and navigate to http://localhost:8051 (or your custom front-end port)

Option 2: Docker 🐳

A Docker image is available for easy setup:

1. Pull the Docker image:

   docker pull victorgoubet/capitalquest:latest

2. Run the container:

   docker run -p 8051:8051 victorgoubet/capitalquest:latest

3. Access the game at http://localhost:8051

---