virtualenv .. This will then set up a a virtual python environment within that directory.
+```bash
+# Create a virtual environment in the project directory using virtualenv
+virtualenv .
- - Next, type source bin/activate. You should see that your command prompt has changed to the name of the folder. This means that you can install packages in here without affecting affecting files outside. To deactivate, type deactivate
+# Activate the virtual environment
+# On macOS/Linux:
+source bin/activate
- - Rather than hunting around for the packages you need, you can install in one step. Type pip install -r requirements.txt. This will install all the packages listed in the respective file. If you install a package, make sure others know by updating the requirements.txt file. An easy way to do this is pip freeze > requirements.txt
+# On Windows (Command Prompt):
+Scripts\activate
- - Flask requires that you set an environmental variable to the python file. However you do that, you'll want to set the file to be server.py. Check [here](https://flask.palletsprojects.com/en/1.1.x/quickstart/#a-minimal-application) for more details
+# On Windows (PowerShell):
+.\Scripts\activate
+```
- - You should now be ready to test the application. In the directory, type either flask run or python -m flask run. The app should respond with an address you should be able to go to using your browser.
+Your terminal prompt should now indicate the virtual environment is active.
-4. Current Setup
+> **โ ๏ธ Note:** Always activate the virtual environment before running the app or tests.
- The app is powered by [JSON files](https://www.tutorialspoint.com/json/json_quick_guide.htm). This is to get around having a DB until we actually need one. The main ones are:
-
- * competitions.json - list of competitions
- * clubs.json - list of clubs with relevant information. You can look here to see what email addresses the app will accept for login.
+---
-5. Testing
+### Install Dependencies
- You are free to use whatever testing framework you like-the main thing is that you can show what tests you are using.
+With the virtual environment active, install all required packages:
- We also like to show how well we're testing, so there's a module called
- [coverage](https://coverage.readthedocs.io/en/coverage-5.1/) you should add to your project.
+```bash
+pip install --upgrade pip # Optional: upgrade pip to the latest version
+pip install -r requirements.txt
+```
+> **๐ก Tip:** If you add a new package, update `requirements.txt` with:
+> ```bash
+> pip freeze > requirements.txt
+> ```
+
+---
+
+## โถ๏ธ Running the Application
+
+Set the Flask environment variable and start the development server:
+
+```bash
+# On macOS/Linux:
+export FLASK_APP=server.py
+flask run
+
+# On Windows (Command Prompt):
+set FLASK_APP=server.py
+flask run
+
+# On Windows (PowerShell):
+$env:FLASK_APP = "server.py"
+flask run
+```
+
+The app should start on `http://127.0.0.1:5000/`. Open this address in your browser to access the **GudLift Registration Portal**.
+
+---
+
+## ๐ Project Structure
+
+The application uses **JSON files** for data storage (no database required):
+
+- `competitions.json` โ List of available competitions
+- `clubs.json` โ List of clubs with their email and points
+
+> **๐ Tip:** Check these files to see valid login emails and available competitions.
+
+---
+
+## ๐งช Running Tests
+
+This project includes **unit tests**, **integration tests**, and **functional tests**.
+
+### Run All Tests
+
+```bash
+# Install pytest if not already installed
+pip install pytest
+
+# Run all tests
+pytest
+```
+### ๐ Testing Results
+
+Here's an example of pytest testing results:
+
+
+
+
+### Run Specific Test Suites
+
+```bash
+# Run only unit tests
+pytest tests/unit/
+
+# Run only integration tests
+pytest tests/integration/
+
+# Run only functional tests
+pytest tests/functional/
+
+# Run tests with verbose output
+pytest -v
+```
+
+### Run Tests with Coverage
+
+To check test coverage (how much of your code is tested):
+
+```bash
+# Install coverage if not already installed
+pip install coverage
+
+# Run tests with coverage and generate an HTML report
+pytest --cov=. --cov-report html
+
+#Open the report in your browser
+open htmlcov/index.html # macOS
+start htmlcov/index.html # Windows
+xdg-open htmlcov/index.html # Linux
+
+```
+
+### ๐ Coverage Test Results
+
+Here's an example of coverage test results:
+
+
+
+---
+
+## ๐ Performance Testing with Locust
+
+[Locust](https://locust.io/) is used for **load testing** to simulate multiple users and check how the application performs under stress.
+
+### Install Locust
+
+```bash
+# Install locust if not already installed
+pip install locust
+```
+
+### Run Locust Tests
+
+```bash
+locust -f tests/performance/locustfile.py
+```
+
+### Using the Locust Web Interface
+
+1. Open `http://localhost:8089` in your browser.
+2. Set the **Number of total users** (e.g., 10).
+3. Set the **Spawn rate** (users per second, e.g., 1).
+4. Click **Start swarming**.
+5. Monitor:
+ - **Response times** (in ms)
+ - **Request rate** (RPS)
+ - **Failure rate**
+ - **Number of users**
+
+> **๐ก Tip:** Stop the test with `Ctrl+C` in the terminal or click **Stop** in the web interface.
+
+### ๐ Locust Performance Test Results
+
+Here's an example of performance test results with Locust:
+
+
+
+---
+
+## ๐ Code Quality & Linting
+
+This project uses **Flake8** to ensure code compliance with [PEP 8](https://peps.python.org/pep-0008/) style guidelines.
+
+### Generate an HTML Report
+
+With the virtual environment active, to generate and visualize Flake8 results in a browser:
+
+```bash
+# Generate a detailed HTML report
+flake8 --format=html --htmldir=flake8_report
+
+# Open the report in your browser
+open flake8_report/index.html # macOS
+start flake8_report/index.html # Windows
+xdg-open flake8_report/index.html # Linux
+```
+
+### ๐ Flake8 Report
+
+Here's an example of Flake8 html report:
+
+
+
+---
+
+## ๐ Notes
+
+- The virtual environment files (`bin/`, `Scripts/`, `lib/`, etc.) are **not committed** to Git (add them to `.gitignore`).
+- Always **deactivate** the virtual environment when done:
+ ```bash
+ deactivate
\ No newline at end of file
diff --git a/clubs.json b/clubs.json
index 1d7ad1ffe..7f9e77958 100644
--- a/clubs.json
+++ b/clubs.json
@@ -12,5 +12,65 @@
{ "name":"She Lifts",
"email": "kate@shelifts.co.uk",
"points":"12"
+ },
+ {
+ "name": "Power House Gym",
+ "email": "contact@powerhousegym.com",
+ "points": "8"
+ },
+ {
+ "name": "Fit Nation",
+ "email": "info@fitnation.org",
+ "points": "15"
+ },
+ {
+ "name": "Stronghold Fitness",
+ "email": "hello@strongholdfit.com",
+ "points": "6"
+ },
+ {
+ "name": "Elite Training",
+ "email": "train@elitetraining.net",
+ "points": "10"
+ },
+ {
+ "name": "Viking Strength",
+ "email": "admin@vikingstrength.io",
+ "points": "5"
+ },
+ {
+ "name": "Zenith Club",
+ "email": "members@zenithclub.co",
+ "points": "11"
+ },
+ {
+ "name": "Titan Fitness",
+ "email": "support@titanfitness.com",
+ "points": "7"
+ },
+ {
+ "name": "Apex Athletics",
+ "email": "contact@apexathletics.com",
+ "points": "14"
+ },
+ {
+ "name": "Olympus Gym",
+ "email": "info@olympusgym.net",
+ "points": "9"
+ },
+ {
+ "name": "Iron Will",
+ "email": "admin@ironwill.fit",
+ "points": "13"
+ },
+ {
+ "name": "Champion's Club",
+ "email": "members@championsclub.org",
+ "points": "16"
+ },
+ {
+ "name": "Phoenix Rising",
+ "email": "hello@phoenixrising.gym",
+ "points": "4"
}
]}
\ No newline at end of file
diff --git a/competitions.json b/competitions.json
index 039fc61bd..2b7b6af54 100644
--- a/competitions.json
+++ b/competitions.json
@@ -2,13 +2,53 @@
"competitions": [
{
"name": "Spring Festival",
- "date": "2020-03-27 10:00:00",
- "numberOfPlaces": "25"
+ "date": "2026-03-27 10:00:00",
+ "number_of_places": "25"
},
{
"name": "Fall Classic",
- "date": "2020-10-22 13:30:00",
- "numberOfPlaces": "13"
+ "date": "2026-10-22 13:30:00",
+ "number_of_places": "13"
+ },
+ {
+ "name": "Summer Showdown",
+ "date": "2026-08-15 09:00:00",
+ "number_of_places": "20"
+ },
+ {
+ "name": "Autumn Challenge",
+ "date": "2026-09-12 14:00:00",
+ "number_of_places": "18"
+ },
+ {
+ "name": "Winter Open",
+ "date": "2026-11-05 11:00:00",
+ "number_of_places": "22"
+ },
+ {
+ "name": "New Year's Cup",
+ "date": "2027-01-10 10:00:00",
+ "number_of_places": "15"
+ },
+ {
+ "name": "Valentine's Clash",
+ "date": "2027-02-14 15:00:00",
+ "number_of_places": "12"
+ },
+ {
+ "name": "Spring Cup",
+ "date": "2027-03-20 12:00:00",
+ "number_of_places": "20"
+ },
+ {
+ "name": "Summer Slam",
+ "date": "2027-06-18 13:00:00",
+ "number_of_places": "25"
+ },
+ {
+ "name": "Grand Finale",
+ "date": "2027-08-22 10:00:00",
+ "number_of_places": "30"
}
]
}
\ No newline at end of file
diff --git a/flake8_report/back.svg b/flake8_report/back.svg
new file mode 100644
index 000000000..ce80d2e6d
--- /dev/null
+++ b/flake8_report/back.svg
@@ -0,0 +1,73 @@
+
+
+
+
diff --git a/flake8_report/file.svg b/flake8_report/file.svg
new file mode 100644
index 000000000..98706cfe5
--- /dev/null
+++ b/flake8_report/file.svg
@@ -0,0 +1,64 @@
+
+
+
+
diff --git a/flake8_report/index.html b/flake8_report/index.html
new file mode 100644
index 000000000..d34838bd3
--- /dev/null
+++ b/flake8_report/index.html
@@ -0,0 +1,30 @@
+
+
+
+ Generated on 2026-08-03 19:37 + with Installed plugins: flake8-html: 0.4.3, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0 +
+No flake8 errors found in 17 files scanned.
+
+
+ 
+
+ tests/unit/tempo.py
+
+ Line too long (84 > 79 characters):
+ + + 41 """Case 3 โ valid file with a single club: returns list with one element.""" + +Line too long (81 > 79 characters):
+ + + 92 """Case 3 โ valid file with single competition: list with one element.""" + +Line too long (82 > 79 characters):
+ + + 204 assert strip_white_space(" john@simplylift.co ") == "john@simplylift.co" + +Line too long (81 > 79 characters):
+ + + 261 get_competition_by_name("Nonexistent Competition", mock_competitions) + +Line too long (84 > 79 characters):
+ + + 281 def test_get_competition_places_with_valid_competition(self, mock_competitions): + +Line too long (80 > 79 characters):
+ + + 479 mock_competitions): + +Line too long (83 > 79 characters):
+ + + 487 def test_get_logged_club_with_valid_session(self, request_session, mock_clubs): + +
+ tests/unit/tempo.py source
+
+ Logged in as {{ session.get('club_name') }}.
+ {% endif %} + +Places available: {{ competition['number_of_places'] }}
+ + {% set max_places = [12, club['points']|int, competition['number_of_places']|int] | min %} + +Logged in as {{ session.get('club_name') }}.
+ {% endif %} + + {% with messages = get_flashed_messages() %} + {% if messages %} +Please enter your secretary email to continue:
+ +| Club | +Available Points | +
|---|---|
| {{ club['name'] }} | +{{ club['points'] }} | +
Logged in as {{ session.get('club_name') }}.
+ {% endif %} + +Points available: {{ club['points'] }}
+{{ comp['name'] }}
+Date: {{ comp['date'] }}
+Number of Places: {{ comp['number_of_places'] }}
+ {% if comp['can_book'] %} + Book Places + {% endif %} +