Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 2.05 KB

README.md

File metadata and controls

40 lines (23 loc) · 2.05 KB

Flagging Website

Our website is live at: https://crwa-flagging.herokuapp.com/

ODSC blog post about this project: https://opendatascience.com/civic-data-science-for-the-charles-river-watershed-association/

Overview

This is the code base for the Charles River Watershed Association's ("CRWA") flagging website. The flagging website hosts an interface for the CRWA's staff to monitor the outputs of a predictive model that determines whether it is reasonably safe to swim or boat in the Charles River.

This code base is built in Python 3.10+ and utilizes the Flask library heavily. The website can be run locally in development mode, and it can be deployed to Heroku using Gunicorn.

For Developers and Maintainers

Read our documentation here. Our documentation contains information on everything related to the website, including first time setup.

docker compose build
docker compose up -d
docker compose exec web flask psql init
docker compose up

Deploy to Heroku

Deploy

For demo mode deployment: Set the FLASK_ENV variable to demo to run a version of this website in production using the demo data. You can leave all the API credentials fields blank.

For full CRWA production deployment: See the docs.

Note: Depending on how actively maintained this repo is, you may need to update runtime.txt by the time you read this. See here for supported Python runtimes.

Credits

This website was built by volunteers at Code for Boston in collaboration with the Charles River Watershed Association.