initial commit

Author: dompatmore

.DS_Store

@@ -0,0 +1,7 @@
+bin
+include
+lib
+.Python
+tests/
+.envrc
+__pycache__

.gitignore

@@ -1 +1,50 @@
-# Python_Testing
+# gudlift-registration
+
+1. Why
+
+
+    This is a proof of concept (POC) project to show a light-weight version of our competition booking platform. The aim is the keep things as light as possible, and use feedback from the users to iterate.
+
+2. Getting Started
+
+    This project uses the following technologies:
+
+    * Python v3.x+
+
+    * [Flask](https://flask.palletsprojects.com/en/1.1.x/)
+
+        Whereas Django does a lot of things for us out of the box, Flask allows us to add only what we need
+
+    * [Virtual environment](https://virtualenv.pypa.io/en/stable/installation.html)
+
+        This ensures you'll be able to install the correct packages without interfering with Python on your machine.
+
+        Before you begin, please ensure you have this installed globally.
+
+
+3. Installation
+
+    - After cloning, change into the directory and type <code>virtualenv .</code>. This will then set up a a virtual python environment within that directory.
+
+    - Next, type <code>source bin/activate</code>. 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 <code>deactivate</code>
+
+    - Rather than hunting around for the packages you need, you can install in one step. Type <code>pip install -r requirements.txt</code>. 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 <code>pip freeze > requirements.txt</code>
+
+    - 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 <code>server.py</code>. Check [here](https://flask.palletsprojects.com/en/1.1.x/quickstart/#a-minimal-application) for more details
+
+    - You should now be ready to test the application. In the directory, type either <code>flask run</code> or <code>python -m flask run</code>. The app should respond with an address you should be able to go to using your browser.
+
+4. Current Setup
+
+    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
+
+    You are free to use whatever testing framework you like-the main thing is that you can show what tests you are using.
+
+    We also like to show how well we're testing, so we there's a module called 
+    [coverage](https://coverage.readthedocs.io/en/coverage-5.1/) you should add to  your project.
+

README.md

@@ -0,0 +1,16 @@
+{"clubs":[
+    {
+        "name":"Simply Lift",
+        "email":"john@simplylift.co",
+        "points":"13"
+    },
+    {
+        "name":"Iron Temple",
+        "email": "admin@irontemple.com",
+        "points":"4"
+    },
+    {   "name":"She Lifts",
+        "email": "kate@shelifts.co.uk",
+        "points":"12"
+    }
+]}

clubs.json

@@ -0,0 +1,14 @@
+{
+    "competitions": [
+        {
+            "name": "Spring Festival",
+            "date": "2020-03-27 10:00:00",
+            "numberOfPlaces": "25"
+        },
+        {
+            "name": "Fall Classic",
+            "date": "2020-10-22 13:30:00",
+            "numberOfPlaces": "13"
+        }
+    ]
+}

competitions.json

@@ -0,0 +1,6 @@
+click==7.1.2
+Flask==1.1.2
+itsdangerous==1.1.0
+Jinja2==2.11.2
+MarkupSafe==1.1.1
+Werkzeug==1.0.1

requirements.txt

@@ -0,0 +1,59 @@
+import json
+from flask import Flask,render_template,request,redirect,flash,url_for
+
+
+def loadClubs():
+    with open('clubs.json') as c:
+         listOfClubs = json.load(c)['clubs']
+         return listOfClubs
+
+
+def loadCompetitions():
+    with open('competitions.json') as comps:
+         listOfCompetitions = json.load(comps)['competitions']
+         return listOfCompetitions
+
+
+app = Flask(__name__)
+app.secret_key = 'something_special'
+
+competitions = loadCompetitions()
+clubs = loadClubs()
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@app.route('/showSummary',methods=['POST'])
+def showSummary():
+    club = [club for club in clubs if club['email'] == request.form['email']][0]
+    return render_template('welcome.html',club=club,competitions=competitions)
+
+
+@app.route('/book/<competition>/<club>')
+def book(competition,club):
+    foundClub = [c for c in clubs if c['name'] == club][0]
+    foundCompetition = [c for c in competitions if c['name'] == competition][0]
+    if foundClub and foundCompetition:
+        return render_template('booking.html',club=foundClub,competition=foundCompetition)
+    else:
+        flash("Something went wrong-please try again")
+        return render_template('welcome.html', club=club, competitions=competitions)
+
+
+@app.route('/purchasePlaces',methods=['POST'])
+def purchasePlaces():
+    competition = [c for c in competitions if c['name'] == request.form['competition']][0]
+    club = [c for c in clubs if c['name'] == request.form['club']][0]
+    placesRequired = int(request.form['places'])
+    competition['numberOfPlaces'] = int(competition['numberOfPlaces'])-placesRequired
+    flash('Great-booking complete!')
+    return render_template('welcome.html', club=club, competitions=competitions)
+
+
+# TODO: Add route for points display
+
+
+@app.route('/logout')
+def logout():
+    return redirect(url_for('index'))

server.py

@@ -0,0 +1,17 @@
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Booking for {{competition['name']}} || GUDLFT</title>
+</head>
+<body>
+    <h2>{{competition['name']}}</h2>
+    Places available: {{competition['numberOfPlaces']}}
+    <form action="/purchasePlaces" method="post">
+        <input type="hidden" name="club" value="{{club['name']}}">
+        <input type="hidden" name="competition" value="{{competition['name']}}">
+        <label for="places">How many places?</label><input type="number" name="places" id=""/>
+        <button type="submit">Book</button>
+    </form>
+</body>
+</html>

templates/booking.html

@@ -0,0 +1,16 @@
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>GUDLFT Registration</title>
+</head>
+<body>
+    <h1>Welcome to the GUDLFT Registration Portal!</h1>
+    Please enter your secretary email to continue:
+    <form action="showSummary" method="post">
+        <label for="email">Email:</label>
+        <input type="email" name="email" id=""/>
+        <button type="submit">Enter</button>
+    </form>
+</body>
+</html>

templates/index.html

@@ -0,0 +1,36 @@
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Summary | GUDLFT Registration</title>
+</head>
+<body>
+        <h2>Welcome, {{club['email']}} </h2><a href="{{url_for('logout')}}">Logout</a>
+
+    {% with messages = get_flashed_messages()%}
+    {% if messages %}
+        <ul>
+       {% for message in messages %}
+            <li>{{message}}</li>
+        {% endfor %}
+       </ul>
+    {% endif%}
+    Points available: {{club['points']}}
+    <h3>Competitions:</h3>
+    <ul>
+        {% for comp in competitions%}
+        <li>
+            {{comp['name']}}<br />
+            Date: {{comp['date']}}</br>
+            Number of Places: {{comp['numberOfPlaces']}}
+            {%if comp['numberOfPlaces']|int >0%}
+            <a href="{{ url_for('book',competition=comp['name'],club=club['name']) }}">Book Places</a>
+            {%endif%}
+        </li>
+        <hr />
+        {% endfor %}
+    </ul>
+    {%endwith%}
+
+</body>
+</html>