The first RESTful API for the Federal Election Commission. We're aiming to make campaign finance more accessible for journalists, academics, developers, and other transparency seekers.
Home Page: https://api.open.fec.gov/developers
License: Other
Right now, both the API server and HTSQL run in tmux, which contains no built-in restarting if they crash. Should set them up to restart when necessary, probably with a process control server like Supervisor.
Determine what kind of proxy we need and if we build our own.
What relationships can we responsibly express between candidates, committees, and expenditures? What technology can we use to generate and display these relationships?
Whenever a search is submitted or you browse candidates, see the election cycle filter active by default and set to 2012.
Dependency:
#25
Tag up with @seanherron
Write HTML and CSS for candidate UI filters.
Go into browse view or choose candidate from search disambiguation, see filters reasonably close to how they appear in Noah's mocks.
Dependency:
#25
Type a query into the search bar, hit enter or click submit button, see search disambiguation page with candidates results.
Dependency:
Candidate endpoint
To make the form fields pretty like they are in Noah's mocks.
Be able to:
Select a filter, see filter field show as active, add box with filter + an x to deactivate filter, results table updates with new data.
Click x on a filter, filter form becomes deactivated, filter box goes away, results tables updates with new data.
Dependency:
Determine how application will know what select form field values should be present. Build solution or determine list of hard coded values as appropriate.
@rjmajma ^^
Candidate names with basic info and FEC_ids would be sufficent. Then, if a user clicked on a candidate it could be simple query by fec_id to get that candidate's results.
There can be other ways to implement this. Feel free to discuss.
This should support issue #35
Implement design from https://github.com/18F/openFEC/issues/19
To manage client side dependencies.
Create the default and activate the associated test.
Click through to candidates via disambiguation view or by choosing to browse all candidates, see table of candidate data.
Dependency:
Candidate endpoint
Decision on what columns/fields are shown for candidate results.
Before deploying our API into the public, or shortly thereafter, we should write good documentation around it.
I'd like to create a live document (an IPython Notebook, specifically) to report on various aspects of the database architecture and status, so that these things can be re-checked and verified easily and at will. Obvious items to include:
In the future this could be expanded into a sort of test suite for the architecture - status checks can be built so that they throw errors when undesirable results are found, and the whole thing can be run automatically & notify us of failures.
By making it an IPython notebook, the executable parts (what is the status? should that raise an alarm?) can be mixed with the documentation (why is that a problem? what should we do?)
Makes sense to bake this in. We were going to default to 20 results per page but make it flexible, though some max record celling would be needed eventually.
Theresa has graciously volunteered for this.
What are our personas searching for?
Waiting on #3.
Tag up with @seanherron
As we near deploying our API into the public, we should add the version into the URL so that we won't cause regressions in users' applications if we make significant changes.
/candidate queries should support these filters:
Filter by Election cycle
Filter by political party
Filter by state
Filter by district
Filter by office sought
Tied to #12
Should be Source Code Pro, 14px: http://www.google.com/fonts/specimen/Source+Code+Pro
Success criteria:
Go into browse view or click in from search, see a results table that looks reasonably similar to Noah's mocks.
Dependency:
#27
@LindsayYoung Will provide us a list of all possible data fields that can be associated with search results.
@jehlers @noahmanger and @LindsayYoung will decide which ones make sense to include!
Please add a value into that pagination object like num_pages that has the total number of pages given the query and per_page value.
Research how this should be displayed and what data to use.
So that when changes are merged into master, the demo server updates.
Viewing a results table of candidates, be presented with prev, next links to see more candidate rows. See total number of results across pages and what numbers of rows you're currently looking at.
Dependency:
Candidate endpoint with pagination
Tied to #11
Type in a search and hit enter or submit, see a summary of candidate results.
Dependency:
API endpoint
https://github.com/18F/openFEC/issues/75
How do users want to search for relationships between candidates, committees, expenditures, etc. and how can we illustrate this?
Dependent on issue #1.
Candidate pages are reached from a search results page (or eventually directly from a search).
Questions to answer:
API result should
Can draw on Sean's preliminary design at https://github.com/18F/FEC/tree/master/api
Implementing the desired design is a separate ticket
Goal: Satisfying speed when end-users query via the app or API
Criteria: The following queries against production complete within the specified desired times:
(TBD)
Steps:
Dependencies: None (except getting the criteria queries)
User need: Coddle short postmodern attention spans
Write the markupz.
Implement some 18F generic styling.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
