Starter Flask Application

Requirements

Homebrew
Python 3
Virtualenv
Virtualenvwrapper
MySQL server

Running Locally

Step 1. Clone this repo

$ git clone https://github.com/jqn/microservices.git

Step 2. Move into the project root directory

$ cd microservices

Step 2. Create and activate a new virtual environment

$ mkvirtualenv microservices

$ workon microservices

Step 4. Set your environment variables

$ vi ~/.virtualenvs/microservices/bin/postactivate

#!/bin/bash
# This hook is sourced after this virtualenv is activated.
export FLASK_ENV=development
export FLASK_CONFIG=development
export FLASK_APP=run.py
export FLASK_DEBUG=True
# dashboard
export AWS_ACCESS_KEY_ID=access_key_id
export AWS_SECRET_ACCESS_KEY=secret_access_key
# github
export GITHUB_TOKEN=github_token

Step 5. Install the project dependencies

$ pip install -r requirements.txt

Step 6. Create a new instance directory and a config.py file instance/config.py

$ cd microservices
$ mkdir instance
$ touch instance/config.py

Add the following and please replace the placeholders with the appropiate values for your app.

SECRET_KEY = 'yoursecretkey'

SQLALCHEMY_DATABASE_URI = "mysql+mysqlconnector://{username}:{password}@{hostname}/{databasename}".format(
    username="username",
    password="password",
    hostname="localhost",
    databasename="microservices",
)

Step 7. Create a new database for this project

$ mysql -u root -p

$ mysql> CREATE DATABASE microservices;
Query OK, 1 row affected (0.00 sec)

Type exit to leave the mysql shell

Step 8. Initialze the database migration

$ flask db init

Step 9. Create the first migration

$ flask db migrate

Step 10. Apply the migration to create the guest_users table in the database

$ flask db upgrade

Step 11. Create an admin user. Please remember to use your own credentials as this repo is public.

$ flask shell

>>> from app.models import Employee

>>> from app import db

>>> admin = Employee(email="admin@admin.com",username="admin",password="admin2016",is_admin=True)

>>> db.session.add(admin)

>>> db.session.commit()

Type exit() to leave the flask shell

Step 12. Start the server

$ flask run

Tips

If installing new dependencies add them to requirements.txt and commit them to version control

$ pip freeze > requirements.txt

Externally Visible Server

$ flask run --host=0.0.0.0

Features

BluePrints
Active EC2 Instances card
Github repo list card