Country guesser by GlutenFreePizza

Roster

• Michelle - Frontend development (HTML, CSS, Bootstrap)
• Ivan - PM, Backend development (Flask, API calls)
• Anastasia - Database development (SQLite, Python)
• Tahmim - Integration (Connect frontent with backend)

Site Description

This project is a country guessing game where users must identify a country based on progressively more revealing hints. The website uses a database to store user information, APIs to generate the hints, and Bootstrap to provide a clean frontend view.

Install Guide

Prerequisites

Ensure that Git is installed on your machine. For help, refer to the following documentation: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

How to clone/install

1. In terminal, clone the repository to your local machine:

HTTPS METHOD:

git clone https://github.com/IvanTardis/glutenFreePizza__ivang86_anastasial25_jiayingz16_tahmimh2.git      

SSH METHOD (requires the SSH key):

git clone git@github.com:IvanTardis/glutenFreePizza__ivang86_anastasial25_jiayingz16_tahmimh2.git

2. Navigate to project directory:

cd PATH/TO/glutenFreePizza__ivang86_anastasial25_jiayingz16_tahmimh2

3. Install dependencies

pip install -r requirements.txt

Launch Codes

Prerequisites

Ensure that Git and Python are installed on your machine. It is recommended that you use a virtual machine when running this project to avoid any possible conflicts. For help, refer to the following documentation:

1. Installing Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
2. Installing Python: https://www.python.org/downloads/

How to run

1. Create Python virtual environment:

python3 -m PATH/TO/venv_name

2. Activate virtual environment

   • Linux: . PATH/TO/venv_name/bin/activate
   • Windows (PowerShell): . .\PATH\TO\venv_name\Scripts\activate
   • Windows (Command Prompt): >PATH\TO\venv_name\Scripts\activate
   • macOS: source PATH/TO/venv_name/bin/activate

   Notes

   • If successful, command line will display name of virtual environment: (venv_name)

   • Type deactivate in the terminal to close a virtual environment

3. Navigate to project app directory

 cd PATH/TO/glutenFreePizza__ivang86_anastasial25_jiayingz16_tahmimh2/app/

4. Run App

 python3 __init__.py

5. Open the link that appears in the terminal to be brought to the website
   • You can visit the link via several methods:
     • Control + Clicking on the link
     • Typing/Pasting http://127.0.0.1:5000 in any browser
   • To close the app, press control + C when in the terminal

* Running on http://127.0.0.1:5000