StressBusterz - Group Mini Project Team Members- Natisha Mallick & Mohammed Abdullah https://www.youtube.com/watch?v=3fEtdyr8YOU

This is an application built using Python, Flask and uses Google Cloud.

To run the application follow the following steps.

Step #1 - Clone sources (this repo)

$ # Clone the sources
$ git clone https://github.com/iMuhammadAbdullah/stressbusterz.git
$ cd stressbusterz

Step #2 - Creating a virtual environment

$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate

Step #3 - Installing dependencies

$ # Install requirements
$ pip3 install -r requirements.txt

Step #4 - Creating Tables (SQLite persistance)

$ # Create tables
$ flask shell
$ >>> from app import db
$ >>> db.create_all()

Step #5 - Starting the project

$ # Run the application
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000    - specify the app port (default 5000)  
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the app in browser: http://127.0.0.1:5000/

Code-base structure

Following is the structure of the code.

< PROJECT ROOT >
   |
   |-- app/
   |    |-- static/
   |    |    |-- <css, images>    # CSS files(Custom file)
   |    |
   |    |-- templates/
   |    |    |
   |    |    |-- index.html           # Index File
   |    |    |-- login.html           # Login Page
   |    |    |-- register.html        # Registration Page
   |    |    
   |    |
   |   config.py                      # Provides APP Configuration 
   |   forms.py                       # Defines the login and register Forms 
   |   models.py                      # Defines the models of the app 
   |   views.py                       # App Routes 
   |
   |-- requirements.txt
   |-- run.py
   |
   |-- ************************************************************************