Netherworld's Pretend Minibar

    pcr

    0.1.1 • Public • Published

    PCR Node SDK

    Build Status

    A Node.js wrapper for the Penn Course Review API.

    Install

    To get started, just run

    npm install pcr
    

    Overview

    var PCR = require("pcr")
     
    pcr = new PCR("API_TOKEN")
    pcr.department("CHEM", function(err, result) {
      if (!err) {
        console.log(result)
      }
    })

    Requesting an API token

    To use this library, you must first obtain an API token for Penn Course Review, which can be done here.

    Contributing

    We'd love to accept pull requests! Also, file bugs or ask questions in GitHub issues if you have any problems.

    Getting Started

    1. Fork the repository using GitHub's interface
    2. Git clone your repository using git clone YOUR_GIT_URL
    3. Install the required dependencies using npm install.
    4. Start editing the CoffeeScript source files in src.
    5. Write tests!
    6. Make a pull request back to the original repository.

    Building

    The SDK is written in ES6, so please make your changes in the JS source files in src and they can be compiled into ES5 JavaScript using make js.

    Testing

    You can test the work you have using make test, which uses Mocha to run the tests inside of the test directory. You should have environment variables in your shell that specify your API keys in the format PCR_API_TOKEN. If you prefer to have these tests run while you're editing automatically, you can run make watchtest from your terminal.

    TODO

    • Penn Course Review API
    • Documentation

    Authors

    • Adel Qalieh

    License

    MIT Licensed

    Install

    npm i pcr

    DownloadsWeekly Downloads

    4

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • pennlabs