https://github.com/codeforboston/flagging
Flagging website for CRWA
https://github.com/codeforboston/flagging
Last synced: 4 months ago
JSON representation
Flagging website for CRWA
- Host: GitHub
- URL: https://github.com/codeforboston/flagging
- Owner: codeforboston
- License: mit
- Created: 2020-05-06T01:15:14.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-12-31T02:16:38.000Z (5 months ago)
- Last Synced: 2026-01-04T02:48:46.522Z (5 months ago)
- Language: Python
- Homepage:
- Size: 9.66 MB
- Stars: 4
- Watchers: 4
- Forks: 14
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flagging Website
**Our website is live at: [https://crwa-flagging.herokuapp.com/](https://crwa-flagging.herokuapp.com/)**
**ODSC blog post about this project: [https://opendatascience.com/civic-data-science-for-the-charles-river-watershed-association/](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](https://crwa.org/) ("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.
[](../../actions)
## For Developers and Maintainers
**[Read our documentation here.](https://codeforboston.github.io/flagging/)** Our documentation contains information on everything related to the website, including [first time setup](https://codeforboston.github.io/flagging/setup/).
```shell
docker compose build
docker compose up -d
docker compose exec web flask update-db
docker compose up
```
## Deploy to Heroku
[](https://heroku.com/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](https://devcenter.heroku.com/articles/python-support#supported-runtimes) for supported Python runtimes.
## Credits
This website was built by volunteers at [Code for Boston](https://www.codeforboston.org/) in collaboration with the Charles River Watershed Association.