The Action Center Platform is an online organizing tool maintained by EFF. Administrators can create targeted campaigns where users sign petitions, contact legislators, and engage on social media.
Setup
Follow these instructions to run the Action Center using Docker (recommended). To run the Action Center without Docker, see setup without Docker.
Install Docker ([instructions](https://docs.docker.com/engine/installation/)) and Docker Compose ([instructions](https://docs.docker.com/compose/install/)).
git clone https://github.com/EFForg/action-center-platform.git
Copy docker-compose.yml.example to docker-compose.yml, and .env.example to .env. Fill in the variables in .env according to the instructions in that file. See [notable dependencies](https://vscode-remote+codespaces-002bsilver-002dtrain-002d7v49w7vv79q42pp6x.vscode-resource.vscode-cdn.net/workspaces/action-center-platform/README.md#notable-dependencies) for hints.
Build the docker image: sudo docker-compose build
Run the application: sudo docker-compose up
In a new tab, get a bash shell with access to your app: sudo docker-compose exec app bash.
If you aren't running migrations automatically, run rake db:migrate to migrate the database.
Run rake congress:update to populate CongressMember table.
Notable Dependencies
Amazon S3 secret key and key id
Allows admins to upload images for the ActionPages
[SmartyStreets API](https://smartystreets.com/account/create) key and id
Allows Congress members to be looked up for users
[Phantom of the Capitol](https://github.com/efforg/phantom-of-the-capitol) whitelisting on server side?
Allows users to submit e-messages to congress
[Call Congress](https://github.com/EFForg/call-congress) url and API key
Connects calls between citizens and their congress person using the Twilio API
[Google Civic Information API](https://developers.google.com/civic-information) url and API key
Representative information powered by the Civic Information API
We use this when we need to give a user the ability to find their representatives to complete a state-level email action
Some key limitations: https://developers.google.com/civic-information/docs/data_guidelines?hl=en e.g. "Developer’s using the API should make every effort to ensure all users are met with the same experience. We do not allow holdbacks, A/B testing, or similar experiments."
Using the Action Center
Action Center administrators can create four types of actions:
Call Action
A user is connected to a political leader by phone, leaving a message or sometimes speaking to an aid.
The user is shown a script to read and enters their phone number and email
When they submit their info, they are called and the process begins.
Congress Action
A user stepped through a four-part form to submit their comments to their congress person.
Page 1 asks for the user's street address and zip code.
Based on this information, page 2 displays the user's representatives. User can select which representatives they wish to contact. Then they choose what to fill in for whatever required fields for each representative selected.
Page 3 asks the user to customize the message to be delivered.
Page 4 is the Thank You page with share links for social media.
When creating the action, admin can choose House, Senate, Both or specific legislators
Petition Action
A user signs a petition, leaving an email address and sometimes location data.
Optionally, users can petition local institutions (like universities) and see signatures by institution.
Tweet Action
A user is invited to join a tweet action using their twitter account.
Email Action
A user e-mails a target or
A user submits comments to a congressperson via [Phantom of the Capitol](https://github.com/efforg/phantom-of-the-capitol).
Shared Elements of All Actions
User is presented with a Thank You page at the end where they are invited to share the action via social media.
When creating an action, admin can add partner organizations.
Admin can also customize share messages and thank you email.
Admin chooses a banner image form the library
The title for the action form is always "Take Action".
Administering Users
To get started using the Action Center, create a user and grant them admin privileges. Administrators can create, track, and manage campaigns.
To create an admin user:
If the user doesn't exist yet, create them through the web interface by following the register link in the top nav.
Run the rake task to grant them admin access (including square brackets):
rake users:add_admin[youremail@example.org]
New users will need to complete an e-mail confirmation in order to log in. Administrators can access admin features by clicking admin in the nav.
To remove an admin user:
rake users:remove_admin[youremail@example.org]
To list all admin users:
rake users:list_admins
Delayed Jobs and Cron
Action Center uses DelayedJob to perform certain tasks outside of a web request context. See that repository for information regarding how to run a delayed job worker. If you are deploying with Docker, our docker-compose.yml.example shows how to create a service which processes the job queue indefinitely.
You may also want to automate certain other tasks (such as rake signatures:deduplicate and rake congress:update) to run occasionally. For those deploying with Docker, docker-compose.yml.example illustrates how to create a service which runs these commands periodically using cron.
Embedding Actions
Embedding actions is simple. Just include the following HTML on the page you want the action to be embedded:
<script type="text/javascript" src="https://act.eff.org/action/embed"></script>
Take part in the action!
The link href should point to the action page you wish to embed. You may add ?nosignup=1 to the URL to get newsletter signup fields omitted from the action.
If you want to get fancy, you can modify the embed code to include some of the following parameters, all of which are optional:
<script type="text/javascript">
var ac_embed = {};
ac_embed.css = "https://example.com/hello.css"; // specify a css file url. File must be globally available (i.e. on the Internet, not local or staging).
ac_embed.width = 500; // specify a width manually
ac_embed.no_css = true; // remove all default styles
ac_embed.css_content = "#some_elem"; // specify an element which itself contains some styles
ac_embed.bioguide_ids = ["ID1", "ID2"...] // bioguide IDs of congress members to target
</script>
<script id="some_div" type="text/x-css-content">
body{
background-color: blue;
}
</script>
<script type="text/javascript" src="https://act.eff.org/action/embed"></script>
Take part in the action!
Testing
To run the full test suite, simply run rake with no arguments.
Rspec tests are used for unit testing the app, and some integration testing. Cucumber tests are used for testing API keys, javascript tests, and feature tests.
We use WebMock to stub backend requests to third party services and Puffing Billy to stub frontend (Ajax) requests. Puffing Billy will cache unrecognized requests and play them back during future test runs. To prevent Puffing Billy from making any new requests, set DISABLE_PUFFING_BILLY_REQUESTS=true.
Linting
rake will also run our linting:
Rubocop
Rubocop checks for consistent style across the Ruby areas of the codebase. We use a modified version of Rubocop-Github to stay consistent with SEC.
[Sass Lint] (https://github.com/sasstools/sass-lint)
Sass-lint checks for consistent style across the stylesheets. Our .sass-lint file is derived from SEC.
Deployment
For notes related to deploying Action Center in production, see the project wiki.
Acknowledgements
This project was created by Lilia Kai, Thomas Davis, and Sina Khanifar. Large portions of the codebase are directly attributable to them, while under the employ or contractorship of the Electronic Frontier Foundation in 2014. Thank you Lilia, Thomas, and Sina! The Action Center is currently maintained by the EFF Engineering and Design team.
Styling
The styling is done with SCSS. The partials files are in the stylesheets directory. Admin files are in their own subdirectory.
Bootstrap is also used for much of the styling. Please see the stylesheets/application/bootstrap-custom.scss for what styles may be used.
Bootstrap is used only for styling, not for javascript.
File Structure
The home page layout is in views/welcome/index.html.erb.
The main internal layout is in views/layouts/application.html.erb.
Individiual action views are in views/tools/.
User pages are in views/devise.
All admin layouts are in views/admin.
Licensing
See the LICENSE file for licensing information. This is applicable to the entire project, sans any 3rd party libraries that may be included.
The Action Center Platform is an online organizing tool maintained by EFF. Administrators can create targeted campaigns where users sign petitions, contact legislators, and engage on social media.
Setup
Follow these instructions to run the Action Center using Docker (recommended). To run the Action Center without Docker, see setup without Docker.
Notable Dependencies
Using the Action Center
Action Center administrators can create four types of actions:
Shared Elements of All Actions
Administering Users
To get started using the Action Center, create a user and grant them admin privileges. Administrators can create, track, and manage campaigns.
To create an admin user:
rake users:add_admin[youremail@example.org]
New users will need to complete an e-mail confirmation in order to log in. Administrators can access admin features by clicking admin in the nav.
To remove an admin user:
rake users:remove_admin[youremail@example.org]
To list all admin users:
rake users:list_admins
Delayed Jobs and Cron
Action Center uses DelayedJob to perform certain tasks outside of a web request context. See that repository for information regarding how to run a delayed job worker. If you are deploying with Docker, our docker-compose.yml.example shows how to create a service which processes the job queue indefinitely.
You may also want to automate certain other tasks (such as rake signatures:deduplicate and rake congress:update) to run occasionally. For those deploying with Docker, docker-compose.yml.example illustrates how to create a service which runs these commands periodically using cron.
Embedding Actions
Embedding actions is simple. Just include the following HTML on the page you want the action to be embedded:
<script type="text/javascript" src="https://act.eff.org/action/embed"></script>Take part in the action!
The link href should point to the action page you wish to embed. You may add ?nosignup=1 to the URL to get newsletter signup fields omitted from the action.
If you want to get fancy, you can modify the embed code to include some of the following parameters, all of which are optional:
<script type="text/javascript"> var ac_embed = {}; ac_embed.css = "https://example.com/hello.css"; // specify a css file url. File must be globally available (i.e. on the Internet, not local or staging). ac_embed.width = 500; // specify a width manually ac_embed.no_css = true; // remove all default styles ac_embed.css_content = "#some_elem"; // specify an element which itself contains some styles ac_embed.bioguide_ids = ["ID1", "ID2"...] // bioguide IDs of congress members to target </script> <script id="some_div" type="text/x-css-content"> body{ background-color: blue; } </script> <script type="text/javascript" src="https://act.eff.org/action/embed"></script>Take part in the action!
Testing
To run the full test suite, simply run rake with no arguments.
Rspec tests are used for unit testing the app, and some integration testing. Cucumber tests are used for testing API keys, javascript tests, and feature tests.
We use WebMock to stub backend requests to third party services and Puffing Billy to stub frontend (Ajax) requests. Puffing Billy will cache unrecognized requests and play them back during future test runs. To prevent Puffing Billy from making any new requests, set DISABLE_PUFFING_BILLY_REQUESTS=true.
Linting
rake will also run our linting:
Rubocop
Rubocop checks for consistent style across the Ruby areas of the codebase. We use a modified version of Rubocop-Github to stay consistent with SEC.
[Sass Lint] (https://github.com/sasstools/sass-lint)
Sass-lint checks for consistent style across the stylesheets. Our .sass-lint file is derived from SEC.
Deployment
For notes related to deploying Action Center in production, see the project wiki.
Acknowledgements
This project was created by Lilia Kai, Thomas Davis, and Sina Khanifar. Large portions of the codebase are directly attributable to them, while under the employ or contractorship of the Electronic Frontier Foundation in 2014. Thank you Lilia, Thomas, and Sina! The Action Center is currently maintained by the EFF Engineering and Design team.
Styling
The styling is done with SCSS. The partials files are in the stylesheets directory. Admin files are in their own subdirectory.
Bootstrap is also used for much of the styling. Please see the stylesheets/application/bootstrap-custom.scss for what styles may be used.
Bootstrap is used only for styling, not for javascript.
File Structure
Licensing
See the LICENSE file for licensing information. This is applicable to the entire project, sans any 3rd party libraries that may be included.