Dice rolling game

A dice rolling web application game built with Flask

Requirements

Python 3.8
PostgreSQL database installed locally
Redis server installed locally
Mailtrap account for sending test emails during development

Local Setup

Step 1: Clone the git repository

$ git clone https://github.com/Pythonian/bsawf.git
$ cd bsawf

Step 2: Create a virtual environment and install requirements

$ python3 -m venv venv
$ . venv/bin/activate
(venv) $ pip install wheel
(venv) $ pip install -r requirements.txt

Step 3: Create a .env file and modify the default settings according to your setup

$ cp .env.example .env

Step 4: Install the custom command tools and check out the available commands

$ pip install --editable .
$ snakeeyes

Step 5: Create a PostgreSQL table for the application

$ sudo service postgresql start
$ psql -c "CREATE DATABASE bswaf;" -U user
$ psql -c "CREATE DATABASE bswaf_test;" -U user

Step 6: Create the required database tables

$ snakeeyes db reset --with-testdb

Step 7: Start the redis-server

$ sudo service redis-server start

Step 8: Run the test coverage suite

$ snakeeyes cov

Step 9: Start the development server

$ flask run

Heroku Setup

This guide walks you through deployment on Heroku. You'll need to have Heroku CLI installed locally.

Step 1: Login to heroku via your command prompt and enter your credentials

$ heroku login

Step 2: Create a new application on Heroku

$ heroku create

Step 3: Deploy the app to heroku

$ git push heroku master

Step 4: Configure the addons required for this project

$ heroku addons:create heroku-postgresql:hobby-dev
$ heroku addons:create heroku-redis:hobby-dev

Step 5: Set configuration variables for the app replacing default values with yours

$ heroku config:set SECRET_KEY=8ajs892jsskaloepst3y
$ heroku config:set DEBUG=False
$ heroku config:set FLASK_ENV=production
$ heroku config:set MAIL_DEFAULT_SENDER=no-reply@example.com
$ heroku config:set MAIL_PASSWORD=mypassword
$ heroku config:set MAIL_USERNAME=myusername
$ heroku config:set MAIL_PORT=2525
$ heroku config:set MAIL_SERVER=smtp.mailtrap.io
$ heroku config:set MAIL_USE_SSL=False
$ heroku config:set MAIL_USE_TLS=True
$ heroku config:set ANALYTICS_GOOGLE_UA=XXX

Step 6: Allocate a web and worker process to run our app

$ heroku ps:scale web=1
$ heroku ps:scale worker=1

Step 7: Run the database migration

$ heroku run flask db upgrade

Step 8: Open your application in a browser

$ heroku open