@bitblit/Paratrade-Common

Shared objects (mainly model objects) for the Paratrade API

Introduction

This library is meant, with time, to be the set of objects exported by the Paratrade API (to make it easier to consume those objects on the client side in a typesafe way)

More docs should be available if I ever get this to a version 1.0.x.

Installation

npm install @bitblit/paratrade-common

Usage

TBD

Testing

Not much to test since its just model objects. Still, to run the tests that ARE in here,

npm test

Deployment

I'll write notes-to-self here on how my deployment from CircleCI is actually going to work.

Following the notes from here. Important points:

• Everything in the package that isn't in .gitignore or .npmignore gets uploaded. Review before post

For circleci using these notes

Looks like its my standard - set a release tag and push to Github, CircleCI takes care of the rest:

    git commit -m "New stuff"
    git tag -a release-0.0.5 -m "Because I like it a lot"
    git push origin master --tags

Also following notes from here on converting the typescript into usable javascript+mapping stuff.

Contributing

Pull requests are welcome, although I'm not sure why you'd be interested!