This repository has been archived by the owner. It is now read-only.
Switch branches/tags
contact deploy-quick develop feature/CMS-1444-ElectionCycleText-Changes feature/CMS-1605-2YrPeriod-Label feature/about-reports feature/advanced-data feature/ato-logs feature/audit-search-page feature/audit-search_and_advanced-data feature/boolean-logic-fix feature/calendar-button-rename feature/candidate-redirect-to-even feature/cms-events feature/committee-totals-pages feature/deploy-audit-search feature/design-optA-no-menu feature/design-optB-submenu-redesign feature/election-district-page-redesign feature/ethnio-script-cms feature/feedback-pii-prevention feature/fix-form5-filings-page-categories feature/fix-migrations feature/fix-pagination-style feature/front-end-cleanup feature/govdelivery-footer feature/hiding-pages feature/latest-updates-search feature/load-content feature/meeting-agenda-page-auto-streaming-info feature/more-legal-links feature/move-python-tests-from-webapp-to-feccms-repo feature/multi-column-list feature/new-audit-search-and-advanced-data feature/no-cache-build-test feature/pdf-documents feature/refactor-senate-specials feature/rest-endpoint-for-aos feature/scss-fixes-1781-and-1734 feature/turn-off-compression feature/unification feature/use-email feature/validate-uploads feature/837-digitalgov-search feature/1142-rad-form-validation feature/1222-update-feedback-recruiter-tool feature/1237-homepage-cfd-section-update feature/1391-limit-zip-digits feature/1542-fix-ie-dialog feature/1663-rfai-soo-fix feature/1803-homepage-calendar-filters-fix feature/1810-commissioner-no-photo-fix fix-PCE-filters fix/calendar-filter-counts fix/data-card-styling fix/h4cc-small-edits high-level-py-version-pinning home-page-banner-preview hotfix/analytics-fix-environment-variable hotfix/emergency-use-banner hotfix/fix-district-display hotfix/fix_IE_and_Party_Coord_Exp_links hotfix/more-celery hotfix/update-cms-repo-ownership master more-unification mster release/public-20171220 release/public-20180103 release/public-20180220 release/public-20180307 revert-1273-feature/banner-announcement-expiry
Nothing to show
Clone or download
Pull request Compare This branch is 908 commits behind fecgov:develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github Made instructions more concise Nov 7, 2017
bin
fec
.cfignore
.gitignore
.hound.yml Add javascript boilerplate. Dec 19, 2015
.jshintignore
.jshintrc
CONTRIBUTING.md
LICENSE.md
Procfile
README.md
karma.conf.js
manifest_base.yml
manifest_dev.yml
manifest_feature.yml
manifest_prod.yml
manifest_stage.yml
newrelic.ini Update New Relic config Jan 5, 2017
package-lock.json
package.json
requirements.txt
runtime.txt
tasks.py

README.md

Develop CircleCI

Master Dependency Status

Campaign finance for everyone

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.

The new FEC.gov is a collaboration between 18F and the FEC. It aims to make campaign finance information more accessible (and understandable) to all users.

FEC repositories

We welcome you to explore, make suggestions, and contribute to our code.

This repository, fec-cms, houses the content management system (CMS) for the new FEC.gov.

  • FEC: a general discussion forum. We compile feedback from the FEC.gov feedback widget here, and this is the best place to submit general feedback.
  • openFEC: the first RESTful API for the Federal Election Commission
  • fec-cms: the content management system (CMS) for the new FEC.gov. This project uses Wagtail, an open source CMS written in Python and built on the Django framework.

Get involved

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 at betafeedback@fec.gov.
  • If you're a developer, follow the installation instructions in the README.md page of each repository to run the apps on your computer.

Set up

We are always trying to improve our documentation. If you have suggestions or run into problems please file an issue!

Project prerequisites

  1. Ensure you have the following requirements installed:

    • Python (the latest 3.5 release, which includes pip and and a built-in version of virtualenv called venv).
    • The latest long term support (LTS) or stable release of Node.js (which includes npm).
    • PostgreSQL (the latest 9.6 release).
  2. Set up your Node environment — learn how to do this with our Javascript Ecosystem Guide.

  3. Set up your Python environment — learn how to do this with our Python Ecosystem Guide.

  4. Clone this repository.

Install project dependencies

Use pip to install the Python dependencies:

pip install -r requirements.txt

Use npm to install JavaScript dependencies:

npm install

Give default user privileges to create database

If you would like your default user to create the database, alter their user role:

sudo su - postgres
psql
alter user [default_username] createdb;
\q
exit

Create local databases

Before you can run this project locally, you'll need a development database:

createdb cfdm_cms_test
Load our sample data into the local development database:

For details see the section below: Restoring your local database from a backup

Set environment variables

You will also need to set the environment variables:

Set local environment variables

Connection string for the local database as an environment variable:

export DATABASE_URL=postgresql://:@/cfdm_cms_test

running with openFEC API

By default, FEC_API_URL points to the local running instance of the API (http://localhost:5000). To set the URL for the API as an environment variable, run:

export FEC_API_URL=http://localhost:5000

Set it to either production, dev, or staging API URLs if you are not running the API locally.

for example: (prod API) https://api.open.fec.gov export FEC_API_URL=https://api.open.fec.gov

The base settings file will read this value in instead of using the default (which is http://localhost:5000).

Also set API keys: FEC_WEB_API_KEY and FEC_WEB_API_KEY_PUBLIC

Finish project setup

Once all prerequisites and dependencies are installed, you can finish the project setup by running these commands:

npm run build
cd fec/
./manage.py migrate
./manage.py createsuperuser

Running the application

In the root project folder, run:

cd fec/
./manage.py runserver

Front End Development

Front end assets are all located in /fec/fec/static/*.

Icon building

Icons only need to be built if there are new SVG files in the /fec/fec/static/icons/input directory, which transforms that SVG file into a SCSS variable to be used on the stylesheets.

npm run build-icons

SCSS compilation

npm run build-sass

JavaScript compilation

npm run build-js

Compilation of both SCSS and JS files

npm run build

Command to watch for SCSS and JS changes

npm run watch

Running tests

There are two kinds of tests that you can run with the project, Python tests and JavaScript tests.

To run the JavaScript tests, run this command in the root project directory:

npm run test-single

Note: You may be prompted to allow node to accept connections; this is okay and required for the tests to run.

To run the Python tests, run these commands in the root project directory:

cd fec/
./manage.py test

It's necessary to specify the Postgresql URL, which can be done on the command line, e.g.:

env DATABASE_URL=postgresql://:@/cfdm_cms_test ./manage.py test

Enabling/toggling features

settings/base.py includes a set of FEATURES which can also be enabled using environment flags:

FEC_FEATURE_LEGAL=1 python fec/manage.py runserver

Additional local development instructions

Watch for static asset changes

To watch for changes to JavaScript files, run this command in the root project directory:

npm run watch

Restoring your local database from a backup

Likely only useful for FEC team members

Load our sample data into the local development database from a production backup

first download the web app sample database dump

FEC team can download from the project's google drive folder: CMS DB Backups

then save the file to a local drive: <path/to/backup_file>

then run this command:

pg_restore --dbname cfdm_cms_test --no-acl --no-owner <path/to/backup_file>

Lastly run migrations to account for any very recent changes that are not present in the latest backup run this command: ./manage.py migrate

Deploy

Likely only useful for FEC team members

We use Travis for automated deploys after tests pass. If you want to deploy something it is much better to push an empty commit with a tag than doing a manual deploy.

If there is a problem with Travis and something needs to be deployed, you can do so with the following commands. Though, you will need to pull the environment variables from the space you are deploying to and remake your static assets. That will ensure things like the links are correct. You will also want to clear your dist/ directory. That way, you will not exceed the alloted space.

Before deploying, install the Cloud Foundry CLI and the autopilot plugin:

cf install-plugin autopilot -r CF-Community

Provision development database:

cf create-service rds micro-psql fec-rds-stage

Provision credentials service:

cf cups cms-creds-dev -p '{"DJANGO_SECRET_KEY": "..."}'

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 feature

The deploy task will use the FEC_CF_USERNAME and FEC_CF_PASSWORD environment variables to log in. If these variables are not provided, you will be prompted for your Cloud Foundry credentials.

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|cms]

NOTE: Performing a deploy in this manner will result in a brief period of downtime.

A note about deploying to the feature space

As noted above, you can manually deploy the application if you specify the space you want to deploy to, e.g., invoke deploy --space feature.

In the case of the feature space, there are a few things to note:

  • To deploy to the feature space, an automated deployer account has been set up. To trigger, go to the tasks.py file DEPLOY_RULES here.
  • Only the CMS app is setup and configured for the feature space; it points to the dev space for all other things (e.g., the API).
  • The feature version of the CMS does have New Relic running against it.
  • The CMS in the feature space has its own database that has been loaded with data from a production backup; this data can be refreshed in the future using the same steps outlined in the Wiki.
  • The feature space has its own S3 bucket for content.

SSH

Likely only useful for FEC team members

You can SSH directly into the running app container to help troubleshoot or inspect things with the instance(s). Run the following command:

cf ssh <app name>

Where is the name of the application instance you want to connect to. Once you are logged into the remote secure shell, you'll also want to run this command to setup the shell environment correctly:

. /home/vcap/app/bin/cf_env_setup.sh

More information about using SSH with cloud.dov can be found in the cloud.gov SSH documentation.

Accounts

Accounts are handled in the cms admin. All accounts will be reviewed annually.

Licensing and attribution

A few parts of this project are not in the public domain. Attribution and licensing information for those parts are described in detail in LICENSE.md.

The rest of this project is in the worldwide public domain, released under the CC0 1.0 Universal public domain dedication. Read more in LICENSE.md.

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.