README.md

good-neighbor-halloween

A Django app for Halloween route

Demo

The demo app is turned off now. Check again next year. 😃

• It asks for your address to play.

  

• It generates an optimized route based on the given address.

  

• It sends a text notification if a phone number is provided.

  

Getting Started

Install

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

Use pip install -r requirements-dev.txt for development. It will install pylint and black to enable linting and auto-formatting.

Setup

Create a .env file to configure the AWS SNS, GCP Geocoding API, MapQuest Optimized Route API, and latitude/longitude for the map.

touch .env

And put down the the following information

GCP_KEY=...
MAPQUEST_KEY=...
MAP_LAT=...
MAP_LNG=...
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
AWS_REGION_NAME=...

For deployment to Heroku, use the following commands to set the environment variables of the app.

heroku config:set GCP_KEY=...
heroku config:set MAPQUEST_KEY=...
heroku config:set MAP_LAT=...
heroku config:set MAP_LNG=...
heroku config:set AWS_ACCESS_KEY_ID=...
heroku config:set AWS_SECRET_ACCESS_KEY=...
heroku config:set AWS_REGION_NAME=...

Credits

• Logo by Alpár-Etele Méder
• Halloween Freebie icon set by roundicons.com