The FreshBooks NodeJS SDK allows you to more easily utilize the FreshBooks API.
This repository contains multiple packages:
Package | What it's for | Usage |
---|---|---|
@freshbooks/api |
Get/set data from FreshBooks using the REST API. | README |
@freshbooks/app |
Pre-configured ExpressJS app. Includes authentication via PassportJS. | README |
sdk-examples | SDK code examples | README |
Use your favorite package manager to install any of the packages and save to your package.json
:
$ npm install @freshbooks/api @freshbooks/app
# Or, if you prefer yarn
$ yarn add @freshbooks/api @freshbooks/app
See the API README, the full documentation and check out some of our examples.
See the APP README.
yarn install
yarn build
yarn test
- Make sure everything is up to date locally
- Update CHANGELOG.md and move any changes in "Unreleased" to the new version number
- Commit changes and push to origin
- Pull latest changes from origin
- Update the package versions by executing:
./node_modules/.bin/lerna version
- After the new tags have been pushed to github, log in there and create a release from one of the new tags to push to npm.