Skip to content
This repository has been archived by the owner on May 26, 2018. It is now read-only.

hwayne/safehouse

Repository files navigation

Safehouse

Safehouse is a headless (I didn't write any js or templates), developer-focused (you config it by editing the source code), scale-invariant (it only has one user) django server. You text it or (eventually) email it codewords and parameters, and it does stuff. Like send you a joke. Or text a bunch of your friends saying you're having a serious mental episode and need to talk to someone right now before you cut off your hands.

There's a reason it's called Safehouse, I guess.

I've been developing the code as a personal defensive tool, but a couple of people have expressed interest in setting up copies for themselves, so I'm putting it online. The code is going through continuous mass rearchitecturing. This is my intro project to django and I'm always seeing stuff to fix.

To Use

  1. Copy the code and set it up on a server. Use a venv because venv is nice. Make sure it's a pyvenv3.4. You can install all of the required packages with just pip install -r requirements.
  2. The code assumes you're using Heroku, but I think it should work on any other hosting. Note settings.py assumes postgres, so you'll have to modify it if you want to use MySQL.
  3. Get a Twilio account, and point a number at {applocation}/sms/. This is your Safehouse number.
  4. Add the config values for things in CONFIGVALS.md.
  5. Run python manage.py migrate to create all of the tables. Add contacts with the django admin page ({applocation}/admin).
  6. Text the safehouse number command codes to do things.
  • See the routes wiki page for more details on what you can text and how this works.
  1. Yell at me for not writing full documentation on how to use the Notifier feature.
  • Read the almost full documentation on the notifier wiki page.

Future Changes

  • Delayed messages would be pretty cool, I think. (Sort of implemented with saved message tags... ish.)
  • A full customizable architecture for the notifier.
  • Email functionality.

About

Ostensibly a "scale-invariant" "headless" "developer-targeted" thingimajig, actually a mental health tool.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages