Noun/Pronoun Mix-up

    This package has been deprecated

    Author message:

    Deprecated. Install vbb-rest from Github with `npm i vbb-rest@derhuerst/vbb-rest`.

    vbb-rest

    0.3.0 • Public • Published

    vbb-rest

    vbb-rest is an HTTP server that proxies all requests to the Berlin & Brandenburg public transport (VBB) API. Using the vbb API client library, it wraps the verbose HAFAS interface in a straightforward REST API.

    vbb-rest is written in CoffeeScript and embraces prototypal programming, making it easily extendable. It is MIT-licensed.

    npm version dependency status

    Installing (globally)

    npm install -g vbb-rest

    You can now start the vbb-rest server wherever you want.

    Usage

    The server will forward the VBB API token from the HTTP X-API-Key field, so get one for testing.

    vbb-rest -c <cert> -k <key>   # run the server in "live mode" 

    or

    vbb-restd start -c <cert> -k <key>   # start/stop the server in the background 

    vbb-rest

    Usage:
    vbb-rest -c <cert> -k <key> [-p <port>]
    
    Arguments:
      -c, --cert    The SSL certificate.
      -k, --key     The SSL key.
    
    Options:
      -p, --port    Where the server will listen. Default: 8000
    

    vbb-restd

    Usage:
    vbb-restd start -c <cert> -k <key> [-p <port>]
    vbb-restd stop <id>
    
    Arguments:
      -c, --cert    The SSL certificate.
      -k, --key     The SSL key.
      id            The server process id.
    
    Options:
      -p, --port    Where the server will listen. Default: 8000
    

    When you start a server, it will print its process id.

    vbb-restd start -c <cert> -k <key>
    info: The server <id> has been started.

    You can use the id later to stop the server.

    $ vbb-restd stop <id>.
    info: The server <id> has been stopped.

    Documentation

    Contributing

    If you have a question, found a bug or want to propose a feature, have a look at the issues page.

    Install

    npm i vbb-rest

    DownloadsWeekly Downloads

    2

    Version

    0.3.0

    License

    ISC

    Last publish

    Collaborators

    • derhuerst