Develop
Master
The Federal Election Commission (FEC) releases information to the public about money that’s raised and spent in federal elections — that’s elections for US president, Senate, and House of Representatives.
Are you interested in seeing how much money a candidate raised? Or spent? How much debt they took on? Who contributed to their campaign? The FEC is the authoritative source for that information.
betaFEC is a collaboration between 18F and the FEC. It aims to make campaign finance information more accessible (and understandable) to all users.
We welcome you to explore, make suggestions, and contribute to our code.
This repository, openFEC-web-app, houses the betaFEC web app for exploring campaign finance data.
- FEC: a general discussion forum. We compile feedback from betaFEC’s feedback widget here, and this is the best place to submit general feedback.
- openFEC: betaFEC’s API
- openFEC-web-app: the betaFEC web app for exploring campaign finance data
- fec-style: shared styles and user interface components
- fec-cms: the content management system (CMS) for betaFEC
We’re thrilled you want to get involved!
- Read our contributing guidelines. Then, file an issue or submit a pull request.
- Send us an email.
- If you’re a developer, follow the installation instructions in the README.md page of each repository to run the apps on your computer.
- Check out our StoriesonBoard FEC story map to get a sense of the user needs we'll be addressing in the future.
This application is in Flask. Client side features are managed using Browserify and npm.
It uses Python version 3.4. It's recommended that you create a virtualenv before installing Python dependencies. Don't put your virtualenv in this directory.
Install Python dependencies:
pip install -r requirements.txt
Dependencies for test:
pip install -r requirements.test.txt
Install client side dependencies:
npm install
The Flask app talks to an API for data. See openFEC.
To make the site fully functional, you will need to compile the client side JS and CSS:
npm run build
Then start the server:
FEC_WEB_API_URL='http://fec-dev-api.18f.gov' python manage.py runserver
To view the site, visit http://localhost:3000/.
To run the server and configure it to use a local instance of the OpenFEC API:
python manage.py runserver
To run the server in debug mode set:
export FEC_WEB_DEBUG=true
To watch for changes to .js and .scss:
npm run watch
If you're developing with a local instance of fec-style and want to pull in styles and script changes as you go, use npm link to create a symbolic link to your local fec-style repo:
cd ~/fec-style
npm link
cd ~/openFEC-web-app
npm link fec-style
After linking fec-style, npm run watch will rebuild on changes to your local copy of fec-style's .scss and .js files.
To be able to have links between this app and a local installation of fec-cms:
export FEC_CMS_URL=http://localhost:8000
config.py
includes a set of features which can be enabled using environment variables or
in the config directly.
$ FEC_FEATURE_LEGAL=1 python manage.py runserver
To compile client side JS once:
npm run build-js
Compile Sass once:
npm run build-sass
Compile JS as changes are made:
npm run watch-js
Compile Sass as changes are made:
npm run watch-sass
Likely only useful for 18F team members
Before deploying, install the Cloud Foundry CLI and the autopilot plugin:
cf install-plugin autopilot -r CF-Community
To deploy to Cloud Foundry, run invoke deploy. The deploy task will attempt to detect the appropriate
Cloud Foundry space based the current branch; to override, pass the optional --space flag:
invoke deploy --space dev
The deploy task will use the FEC_CF_USERNAME and FEC_CF_PASSWORD environment variables to log in.
If these variables are not provided, your existing authorization will be used.
You can use cf login to login manually.
Credentials for Cloud Foundry applications are managed using user-provided services labeled as "fec-creds-prod", "fec-creds-stage", and "fec-creds-dev". Services are used to share credentials between the API and the webapp. To set up a service:
cf target -s dev
cf cups fec-creds-dev -p '{"SQLA_CONN": "..."}'
To stand up a user-provided credential service that supports both the API and the webapp, ensure that the following keys are set:
- SQLA_CONN
- FEC_WEB_API_KEY
- FEC_WEB_API_KEY_PUBLIC
- FEC_GITHUB_TOKEN
- SENTRY_DSN
- SENTRY_PUBLIC_DSN
- NEW_RELIC_LICENSE_KEY
Deploys of a single app can be performed manually by targeting the env/space, and specifying the corresponding manifest, as well as the app you want, like so:
cf target -s [feature|dev|stage|prod] && cf push -f manifest_<[feature|dev|stage|prod]>.yml [api|web]
NOTE: Performing a deploy in this manner will result in a brief period of downtime.
To avoid repeated requests to the OpenFEC API, the webapp can store recent API responses
in a small in-memory cache. The cache can be enabled by setting the FEC_WEB_CACHE
environment variable; the size of the cache, in items, is controlled by the
FEC_WEB_CACHE_SIZE environment variable. When the cache is enabled, views may
be stale for up to the cache duration set by the API.
See the release checklist for details on how to release a new version of betaFEC.
py.test
npm test
This repo includes optional post-merge and post-checkout hooks to ensure that
dependencies and compiled assets are up to date. If enabled, these hooks will
update Python and Node dependencies, and rebuild compiled JS and CSS files,
on checking out or merging changes to requirements.txt, package.json,
or source JS or SCSS files. To enable the hooks, run
invoke add_hooks
To disable, run
invoke remove_hooks
This project is in the public domain within the United States, and we waive worldwide copyright and related rights through CC0 universal public domain dedication. Read more on our license page.
A few restrictions limit the way you can use FEC data. For example, you can’t use contributor lists for commercial purposes or to solicit donations. Learn more on FEC.gov.