💬 SMS bot for reporting blight in Baton Rouge, LA.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
lib
priv
test
.gitignore
.iex.exs
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
Procfile
README.md
mix.exs
mix.lock
nameplate.jpg

README.md

Jabberwocky fights the blight Build status Coverage status

An enigmatic creature that devours blight


Description

Jabberwocky is an SMS-based app that empowers Baton Rouge citizens to report instances of blight and tries to ensure that there reports are handled in a timely fashion.

Roadmap

  • Refine contexts
  • Translate :service_request enums to 311 blight descriptions in emails
  • Add Dialyxir and typespecs
  • Improve code coverage
  • Implement CI to test builds
  • Basic GraphQL web API
  • (Re)design website
    • Branding
    • Blight map
    • Blight stats
    • Service request status check
  • Create escalation emails based on service request age
  • Include images (or image URLs) in service request email
  • Create email templates
  • Move this all to a Trello board

Contributing

Rome wasn’t built in a day, but Jabberwocky sort of was. This project initially launched after a day of coding at the Activate 2018 hackathon. We’re working hard to improve upon our initial vision, but we’d love your help! PRs are welcome—just be sure you adhere to the code of conduct.

Development

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.create && mix ecto.migrate
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

Learn more