Giter VIP home page Giter VIP logo

recap-chrome's Introduction

Build Status

What is this?

This is the code for the RECAP Chrome and Firefox extensions, a program that is used to liberate millions of documents from the PACER system. To install this extension please visit its homepage at https://free.law/recap/.

Reporting Issues

Please report all issues at the centralized RECAP issue repo, /freelawproject/recap.

Joining as a Developer

If you wish to contribute to our efforts to drain PACER, please get in touch using the contact form on Free Law Project's website or simply get to work on an issue that interests you.

Tips

  1. You can load an "unpacked extension" from chrome://extensions/ if you enable developer options in Chrome. The same can be accomplished in Firefox by going to about:debugging, clicking "Load Temporary Add-on" and then selecting any file.

  2. While it's true that every court has their own customized version of PACER, there is a PACER training site that does not charge fees. You can use this if you wish to work on the system without accruing charges. If you are accruing charges while working on this extension, Free Law Project may be able to help. Let us know.

  3. While you're testing things across versions of PACER, you can use a handy website (json/html) created by @audiodude to find suitable versions of PACER.

  4. If you want to auto-zip your code on changes, you have two options. First, you can install a utility called entr and run:

     command ls *.js | entr zip -FSr recap-chrome.zip * --exclude=*node_modules*
    

    Alternatively, for Firefox, you can use the web-ext tool, with a command like:

     web-ext run --firefox-profile recap-debugging --start-url https://ecf.dcd.uscourts.gov/cgi-bin/DktRpt.pl?178502 --start-url https://www.courtlistener.com/docket/4214664/national-veterans-legal-services-program-v-united-states/
    

    To run that you'll need a recap-debugging profile first, but running that will set up auto-reload of the extension in Firefox. It will also load a couple useful URLs in your debugging window.

Tests

We got that! You can (and should) run the tests before you push. To do that, install the dependencies described in package.json by running:

npm install -g grunt-cli

And any other commands in .travis.yml.

Then run:

grunt jasmine

If the tests pass, give a push to your repo and send us a pull request.

When we pull your code using Github, these tests will be automatically run by the Travis-CI continuous integration system. You can make sure that your pull request is good to go by waiting for the automated tests to complete.

For more information on testing see TESTING.md.

The current status if Travis CI on our master branch is:

Build Status

Releasing a New Version

When a new version is needed, the release process is:

  1. Update package.json and manifest.json with a new release version.

  2. Run web-ext lint to ensure no regressions.

  3. Commit the code.

  4. Tag the code with something like:

     git tag -s '0.8.4' -m "Releases 0.8.4, fixing replaceState and pushState to work in Chrome 43." -u '[email protected]' -f
     git push --tags -f
    
  5. Zip up the archive with the rather archaic:

     zip -FSr recap.zip * --exclude=*node_modules*
    
  6. Upload that to the Chrome Market.

  7. Upload that to addons.mozilla.org

  8. Make a new release on Github announcing the release.

Copyright

RECAP for Chrome Copyright 2013 Ka-Ping Yee [email protected]

RECAP for Chrome is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. RECAP for Chrome is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with RECAP for Chrome. If not, see: http://www.gnu.org/licenses/

recap-chrome's People

Contributors

audiodude avatar harlanyu avatar mlissner avatar zestyping avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.