How to run test project

In order to run this test project, your development environment must be set up properly in order to run the site locally without errors. There are a few things you must install.

This setup assumes you are running the project in a Linux environment.

1. Clone this repository.

$ git clone https://github.com/biancamacias/test-flask-project.git

2. Follow the installation process outlined here.

$ cd test-flask-project
$ python3 -m venv venv

3. Activate the virtual environment.

$ source venv/bin/activate

4. Install all the necessary requirements.

$ pip install -r requirements.txt

5. Assuming you have a GCP project, create an OAuth 2.0 Client ID (if you haven't already).

6. Set the redirect URI to be http://127.0.0.1:5000/callback.

7. Download the JSON file generated after creating the client ID and take note of the file path in the project. You can simply add it to the repository. Note: do not push this JSON file to any repository publicly. Keep client secrets a secret.

8. Go through any TODO in app.py and set them accordingly, such as the path of the downloaded JSON file.

9. Run the project. Click the generated local address Flask gives in the terminal where you can test it in your browser.

$ flask run

User Journey

1. Login through index.html page, which redirects user to login with their Google/Gmail credentials.

2. Choose account.

3. View home.html and logout.