Skip to content

WorkingFamilies/Spoke

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Contributor Covenant

WFP Spoke Instance Deployment Notes

WFP Spoke is deployed on Heroku.

In April 2024 we are spinning down our heroku db because we are not actively using it.

The database backup can be found at s3://wfp-misc/wfp-spoke-heroku-backup-20240417.dump

Instructions on how to restore the db from the backup can be found here.

Essentially create a publically accessible signed URL for the db and run heroku pg:backups:restore '$SIGNED_URL' -a wfp-spoke

The app also needs these add-ons to run:

  • bucketeer:micro
  • web (Standard-2X)
  • mailgun:concept50k
  • papertrail:fixa
  • heroku-redis:premium-1

Spoke

Spoke is an open source text-distribution tool for organizations to mobilize supporters and members into action. Spoke allows you to upload phone numbers, customize scripts and assign volunteers to communicate with supporters while allowing organizations to manage the process.

Spoke was created by Saikat Chakrabarti and Sheena Pakanati, and is now maintained by MoveOn.org.

The latest version is 11.1 (see release notes)

Setting up Spoke

The easiest way to get started is with Heroku. You can also learn about Spoke through the texter and admin video demos or in the explanation on how to decide if Spoke is right for you.

For developers, please see our recommendations for deploying locally for development.

Want to know more? Click here to visit the Spoke Documentation microsite!

Quick Start with Heroku

This version of Spoke suitable for testing and, potentially, for small campaigns. This won't cost any money and will not support production(aka large-scale) usage. It's a great way to practice deploying Spoke or see it in action.

Deploy

Follow up instructions located here.

NOTE: You can upgrade this deployment later for use in a production setting, but keep in mind you will need to migrate data from any prior campaigns. Thus it is best to upgrade before you start any live campaigns. This will cost ~$75 ($25 dyno + $50 postgres) a month and should be suitable for production level usage for most organizations. We recommend that if you plan to use Spoke at scale that you use this link to deploy with a production infrastructure from the start!

Please let us know if you deployed by filling out this form here

Other Options for Production Use

You can also deploy on AWS Lambda. which is a lot cheaper than Heroku at scale, but requires considerably more technical knowledge to deploy and maintain. We recommend this option for large scale campaigns with tech resources.

Additional guidance:

License

Spoke is licensed under the GPL3 license with a special author attribution requirement.

About

mass-contact text/SMS distribution tool

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.9%
  • Other 0.1%