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

     Whereas Django does a lot of things for us out of the box, Flask allows us to add only what we need.

   • Virtual environment

     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

   Installation Short Summary - details below the table
   python -m venv env
   source env/bin/activate
   pip install --upgrade pip
   pip install -r requirements.txt
   export FLASK_ENV=development
   python server.py
   Please Note: check your Python interpreter, it should be 3.9.2

   • After cloning, change into the directory and type python -v venv env. This will then set up a a virtual python environment within that directory.

   • Next, type source env/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

   • Rather than hunting around for the packages you need, you can install in one step. Upgrade pip: pip install --upgrade pip, then 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

   • A conditional structure has been implemented in the main file: server.py, in order to be able to open the app typing python server.py in the terminal.

4. Current Setup

   The app is powered by JSON files. 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 there's a module called. coverage you should add to your project.