Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinak/democracy.io
democracy.io
https://github.com/sinak/democracy.io
Last synced: 28 days ago
JSON representation
democracy.io
- Host: GitHub
- URL: https://github.com/sinak/democracy.io
- Owner: sinak
- License: agpl-3.0
- Created: 2015-02-27T19:51:50.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T02:58:51.000Z (almost 2 years ago)
- Last Synced: 2024-11-05T01:34:54.320Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 10.4 MB
- Stars: 258
- Watchers: 23
- Forks: 57
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-democracy - democracy io - commit/sinak/democracy.io.svg?style=social) |  | (Software / Software-Development)
README
Democracy.io
============
[](https://travis-ci.org/EFForg/democracy.io)
Express & Angular app for sending messages to Senate and House members
(c) 2015 Electronic Frontier Foundation
## Table of Contents
* [Background Info](#background-info)
* [Getting Started](#getting-started)
* [App Configuration](#app-configuration)
* [Run tests](#run-tests)
* [Running the server](#running-the-server)
* [Angular App](#angular-app)
## Background Info
Democracy.io is an app for contacting Senate & House members. It provides a user friendly wrapper around the individual member contact forms.
It uses APIs from:
* [Smarty Streets](https://smartystreets.com/docs)
* [Phantom of the Capitol](https://github.com/EFForg/phantom-of-the-capitol)
## Getting started
### Redis
Ensure that Redis is running locally:
```
sudo apt-get install redis-server
```
or install manually via http://redis.io/topics/quickstart - making sure to read the "Securing Redis" section, especially if you install Redis manually.
### App dependencies & build
```
npm install
npm run build
```
### credentials
You can generate required creds by running
```
node bin/gen-creds.js
```
or:
After you've run `npm install` generate a salt for encrypting IP addresses and store it in your local.json file, under: SERVER > CREDENTIALS > IP > SALT
```
var bcrypt = require('bcrypt');
var salt = bcrypt.genSaltSync(10);
console.log(salt);
```
Set a session secret and store it in your local.json file, under: SERVER > CREDENTIALS > SESSION > SECRET
## App Configuration
App config is controlled via the [node-config](https://github.com/lorenwest/node-config) module.
To set credentials, create a local-dev.json file under the [config dir](/config) and override the SERVER.CREDENTIALS setting.
Alternately, you can use:
* [Environment variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables)
* [Command line options](https://github.com/lorenwest/node-config/wiki/Command-Line-Overrides)
## Run tests
```
npm run test
```
## Running the server locally
Spins up a local server to serve the app, including proxying browsersync on top of the express server.
```
gulp serve
```
## Deploying
To deploy the server, simply run:
```
pm2 deploy ecosystem.json5 production
```
For more instructions on setting up a production server, check [/deployment/README.md](deployment/README.md).
## Angular app
See the [www/README.md](/www/README.md) for details