Jim

Jim is a slackbot that responds when a user messages him to say that they have missed going to the gym. It records the the day missed and adds $5 to the truancy pot.

Getting Started

The project uses docker for a containerized workflow, currently there are 2 services:

• jim(Flask app) - this is the backend service which connects with the database, built using the Flask python framework
• db(postgres db) - this is the database used for storing all of the data
• nginx(web server) - this is the webserver, which can also be used as a reverse proxy

Local Development

Each service is built and deployed through Docker. We use docker-compose to orchestrate all the services together. See the Docker site for OS specific installation.

Building and Running Locally

To run and build all the multiple services, they are defined as a separate docker container for each service. We use docker-compose for defining these containers and orchestration. Supplied in the project repo is a docker-compose.yml file.

Building the containers: In the project root folder build the docker containers using docker-compose.yml in your terminal:

#build the docker containers
docker-compose up --build

# For first time setup recreate and seed the db for backed api
docker-compose run jim python manage.py recreate-db

docker-compose run jim python manage.py seed-db

Once the containers are built you can check if the app is running on your browser at http://localhost/ Jim's api lives under at /api for status check you can go to http://localhost/api/

Development Workflow

Please when always working on a new feature checkout a new branch from the latest master branch and when submitting Pull Requests please submit PRs to the development branch from the feature branch you are working off.

Slack App Use

Jim responds to the /jim command by sending a request to to http://noshp-jim.herokuapp.com/slack . The JSON payload of the request differs based on the text after the /jim command

User types /jim stats:

1. Jim runs GROUP BY query on Logs model
2. Jim responds with the number of records each user has in the Logs, and 200 code

User types /jim 5$

1. Jim runs INSERT query into database with userid and timestamp
2. Jim returns angry message chastizing the user, and 200 code

User types /jim and something not above, and jim responds with 500

Non Docker Development

This project is using pipenv as the package/environment management. pipenv is here to combine the whole requirements.txt, virtualenv rituals we've been doing to setup a python project.

Install pipenv specific to your OS

Install dependencies

pipenv automatically installs the packages defined in the pipfile and starts a virtualenv for you. To install the dependecies just run:

pipenv install

To specify a certain version of python when using pipenv run:

pipenv install --python 3.7

Then to activate your pipenv just run:

pipenv shell

The following environment variables must be set for local testing

• APP_ENV - set to "DEV" on local machine

To spin up local Postgres, required for local testing, run project's docker script.

Install docker and docker-compose specific to your OS Then in the project root folder run:

# build and run the postgres container
docker-compose -f docker-compose.yml up -d --build

# to stop the container
docker-compose -f docker-compose.yml down

Running

Once you have your pipenv shell, just export the flask app to your environment variable in the project's root folder:

Shell

export FLASK_APP=application.py
export FLASK_DEBUG=True

Windows Powershell

$env:APP_ENV="DEV"
$env:FLASK_APP=".\application.py"
$env:FLASK_DEBUG="True"

#run flask app
flask run

Command Prompt

SET FLASK_APP=application.py
SET FLASK_DEBUG=True

# First time running of the app 
flask db init
# migrate and upgrade your database
flask db migrate

flask db upgrade

#run flask app
flask run