EasyIP2023 / clean_code

:heavy_check_mark: Group project for the UI course of Spring 2018 :heavy_check_mark:

Clean Code

Usage: Dev port on 5000

Install yarn package manager or nodejs package manager (npm)

Create virtual environment

# If using python 3
python3 -m venv venv
# if using python 3.4 or less
virtualenv venv

source venv/bin/activate
pip install -r requirements.txt

# Make sure you get an upgraded version of whoosh
pip uninstall flask-whooshalchemy
pip install git+git://github.com/miguelgrinberg/flask-whooshalchemy.git

Using virtual environment

source venv/bin/activate
flask db upgrade   # To do database migrations
yarn              # To install node packages
yarn seed         # To populate database

Start flask & webpack for HMR

yarn ds/npm ds    # To start flask and webpack server

Start flask & webpack for static compile

yarn s/npm s    # To start flask and webpack server

For Interactive Shell

flask shell
# or
yarn shell

To see routes

flask list-routes
or
yarn routes

After adding new libs

Be sure to update the requirements.txt

pip freeze > requirements.txt

Logging into admin interface

• username: admin
• password: admin
• email: [e-mail]

Logging into as normal user

• username: Can check for username after logging into admin interface
• password: Password1234
• email: Can check for user email after logging into admin interface