https://github.com/srobbin/sweeparoundus
A Chicago street sweeping alert system and searchable calendar
https://github.com/srobbin/sweeparoundus
Last synced: 3 months ago
JSON representation
A Chicago street sweeping alert system and searchable calendar
- Host: GitHub
- URL: https://github.com/srobbin/sweeparoundus
- Owner: srobbin
- License: mit
- Created: 2021-04-13T21:37:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T03:30:41.000Z (3 months ago)
- Last Synced: 2025-03-25T04:26:22.135Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 7.47 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SweepAround.Us
A Chicago street sweeping alert system and searchable calendar.
## Development
### Initial setup
If this is your first time running the application, you'll need to make sure you have
[Docker](https://docs.docker.com/get-docker/) installed. Assuming you do, issue these commands
from the terminal:
```sh
# Make a copy of the environment variables file
# NOTE: You'll need a Google API key for maps/address autocomplete,
# and a Mailgun API key for sending transactional emails
cp .env.example .env
# Build the Docker image
docker compose build --no-cache
# Run the setup script
docker compose run app bin/setup
# After the setup is completed, run the app
docker compose up
```
### Running the app
From a terminal session:
```sh
# Update to make sure your database and dependencies are in sync
docker compose run app bin/update
# Launch the stack
docker compose up
```
Once the stack is running, visit: [http://localhost:3000](http://localhost:3000)
_Note: you may be required to migrate the database, but you should be able to do this from
the website prompt._
### Gems and console
From time to time, you'll need to install new gems and access the console. In order to do so,
please use the `docker compose run app` command. For example:
```sh
# Installing gems
docker compose run app bundle add foo
# Accessing the console
docker compose run app bin/rails console
# Start a bash shell
docker compose run app /bin/bash
# Run rspec tests
docker compose run app rake spec
OR
docker compose run app bundle exec rake spec
```
### Emails
In development, emails are captured and stored in `/tmp/letter_opener`.
### Annual maintenance
- In late March, export the following files from the [Chicago Data Portal](data.cityofchicago.org):
- "Street Sweeping Zones - 202X" => `Street Sweeping Zones - 202X.geojson`
- "Street Sweeping Schedule - 202X" => `Street_Sweeping_Schedule_-_202X.csv`
- Add files to the `db/data` directory.
- Run rspec test suite.
- Merge into main and deploy.
- Temporarily enable 'Maintenance Mode' on Heroku prior to running non-TEST `SeedYearlyData` service.
- Seed db with new zone and schedule data (note that this will nullify `area_id` in existing alerts):
- TEST: `SeedYearlyData.new(write: false, year: Time.current.year.to_s).call`
- `SeedYearlyData.new(write: true, year: Time.current.year.to_s).call`
- Disable 'Maintenance Mode' on Heroku prior to running non-TEST `SeedYearlyData` service.
- Flip `NEW_SCHEDULES_LIVE` boolean value.
- Destroy alerts that are unconfirmed or don't have an associated street address:
- TEST: `DestroyIneligibleAlerts.new(write: false).call`
- `DestroyIneligibleAlerts.new(write: true).call`
- Carry over existing alerts:
- TEST: `CarryOverExistingAlerts.new(write: false).call`
- `CarryOverExistingAlerts.new(write: true).call`