Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Andrew Carpenter
committed
Jul 25, 2010
1 parent
b70fe58
commit 4656650
Showing
1 changed file
with
15 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,53 @@ | ||
| govpulse | ||
| Federal Register 2.0 | ||
| ======== | ||
|
|
||
| The Federal Register at your fingertips. | ||
|
|
||
| http://govpulse.us | ||
| http://www.federalregister.gov/ | ||
|
|
||
| * The source code is available on Github at [http://github.com/trifecta/govpulse](http://github.com/trifecta/govpulse). | ||
| * Code bugs can be filed at Lighthouse, via [http://govpulse.lighthouseapp.com/projects/35087-govpulseus/overview](http://govpulse.lighthouseapp.com/projects/35087-govpulseus/overview). | ||
| * Problems, suggestions, etc can also be filed at Tender, via [http://govpulse.tenderapp.com/discussions](http://govpulse.tenderapp.com/discussions) | ||
| * The source code is available on Github at [http://github.com/criticaljuncture/fr2](http://github.com/criticaljuncture/fr2). | ||
| * Problems, suggestions, etc can also be filed at Tender, via [http://federalregister.tenderapp.com/discussions](http://federalregister.tenderapp.com/discussions) | ||
|
|
||
| About | ||
| ------------ | ||
|
|
||
| This project was created for the Apps for America 2 contest and as a way for us to use our talents to help others participate in their government. | ||
| The FR 2.0 web site is similar to a daily web newspaper, with a clear layout and new tools to guide readers to the most popular topics and relevant documents. The site displays individual news sections for Money, Environment, World, Science & Technology, Business & Industry, and Health & Public Welfare. FR 2.0 has greatly improved navigation and search tools and highlights each agency’s significant rules. The new web site takes advantage of social media and integrates seamlessly with Regulations.gov and the Unified Agenda to make it easy for users to submit comments directly into the official e-Rulemaking docket, and view the history of rulemaking activity through a regulatory timeline. | ||
|
|
||
| When we embarked on the creation of this site in our spare time, 3 weeks before the Apps for America 2 deadline, we knew that the open source software community would be essential to us realizing our dream. We are deeply indebted to all those who toil everyday to create incredible software and freely share it with the world. We are proud to have toiled along side them and thankful for their efforts to enable us to build a new app and tools we can release back into the community. It is our hope that this app continues to celebrate that spirit and gives back to that community, to the people of the US, and the world. | ||
| The site was built by David Augustine, Bob Burbach, and Andrew Carpenter of CriticalJuncture, using the GovPulse application as a starting point. It is released as an open source project. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| First, you'll need Ruby, Rails 2.3.3, the Sphinx search engine, MySQL, and the ruby MySQL bindings. | ||
| First, you'll need Ruby, Bundler, Rails 2.3.8, the Sphinx search engine, MySQL, and the ruby MySQL bindings. | ||
|
|
||
| git clone git://github.com/trifecta/govpulse.git | ||
| cd govpulse | ||
| git clone git://github.com/criticaljuncture/fr2.git | ||
| cd fr2 | ||
| git submodule init | ||
| git submodule update | ||
|
|
||
| Then you'll need to create the config/database.yml and config/api_keys.yml files, based on the examples. | ||
|
|
||
| Then: | ||
|
|
||
| [sudo] rake gems:install | ||
| bundle install | ||
| rake db:create | ||
| rake db:migrate | ||
|
|
||
| To fetch data, you'll need to run the following tasks | ||
| To fetch data, you'll need to run | ||
|
|
||
| rake data:download:entries | ||
| rake data:download:full_text | ||
| rake data:extract:agencies | ||
| rake thinking_sphinx:index | ||
| rake data:daily DATE=2010-07-26 | ||
|
|
||
| To start up the application, simply run | ||
|
|
||
| script/server | ||
|
|
||
| Contact us at govpulse@gmail.com if you run into any trouble; we'll revise these instructions as necessary to make it easy. | ||
| Contact us at fr2@criticaljuncture.org if you run into any trouble; we'll revise these instructions as necessary to make it easier. | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| govpulse is released under the Affero GPL v3, which requires that the source code be made available to any network user of the application. So while we encourage you to fork and run your own copies of this application, any changes you make need to be shared with their users. Note that this does not allow the use of the govpulse name or logo. | ||
| FR2 is released under the Affero GPL v3, which requires that the source code be made available to any network user of the application. So while we encourage you to fork and run your own copies of this application, any changes you make need to be shared with their users. Note that this does not allow the use of the official logos or the icons. | ||
|
|
||
| govpulse itself is copyrighted by David Augustine, Robert Burbach, and Andrew Carpenter. | ||
|
|
||
| A variety of external libraries are included with this software; they are all open source, and with one exception are suitable for use in any way. | ||
| A variety of external software libraries are included with this software; they are all open source, and suitable for use where this application is. |