Insignia Prototype - GaTech OMSCS 6460 - Summer 2020

The live website will temporarily be available here. Feel free to test out creating your own user or logging in with the demo user: member@example.com / Password1

The instructions below will explain how to run the web application locally. Make sure to initialize the database BEFORE doing the runserver command: python manage.py init_db python manage.py runserver.

---

Code characteristics

• Developed using Python 3.6
• Project directories:
  • app
    • commands
    • models
    • static
    • templates
    • views
  • tests
• Includes test framework (py.test and tox)
• Includes database migration framework (alembic)
• Sends error emails to admins for unhandled exceptions

Setting up a development environment

We assume that you have git and virtualenv and virtualenvwrapper installed.

# Clone the code repository into ~/dev/my_app
mkdir -p ~/dev
cd ~/dev
git clone https://github.com/dylanfloyd/digital-portfolio-networking my_app

# Create the 'my_app' virtual environment
mkvirtualenv -p PATH/TO/PYTHON my_app

# Install required Python packages
cd ~/dev/my_app
workon my_app
pip install -r requirements.txt

Configuring SMTP

Copy the local_settings_example.py file to local_settings.py.

cp app/local_settings_example.py app/local_settings.py

Edit the local_settings.py file.

Specifically set all the MAIL_... settings to match your SMTP settings

Note that Google's SMTP server requires the configuration of "less secure apps". See https://support.google.com/accounts/answer/6010255?hl=en

Note that Yahoo's SMTP server requires the configuration of "Allow apps that use less secure sign in". See https://help.yahoo.com/kb/SLN27791.html

Initializing the Database

# Create DB tables and populate the roles and users tables
python manage.py init_db

# Or if you have Fabric installed:
fab init_db

Running the app

# Start the Flask development web server
python manage.py runserver

# Or if you have Fabric installed:
fab runserver

Point your web browser to http://localhost:5000/

You can make use of the following users:

• email user@example.com with password Password1.
• email admin@example.com with password Password1.

Running the automated tests

# Start the Flask development web server
py.test tests/

# Or if you have Fabric installed:
fab test

Trouble shooting

If you make changes in the Models and run into DB schema issues, delete the sqlite DB file app.sqlite.

See also

• FlaskDash is a starter app for Flask with Flask-User and CoreUI (A Bootstrap Admin Template).

Acknowledgements

With thanks to the following Flask extensions:

• Alembic
• Flask
• Flask-Login
• Flask-Migrate
• Flask-Script
• Flask-User
• Flask-User-starter-app was used as a starting point for this code repository.

Author

• Dylan Floyd -- dylan.floyd@gmail.com