search

freshbooks / freshbooks-nodejs-sdk

Node.js SDK for the FreshBooks API
MIT License
8 stars 12 forks source link
freshbooks freshbooks-api freshbooks-cloud-accounting hacktoberfest sdk

readme

FreshBooks NodeJS SDK

npm node-lts GitHub Workflow Status

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

Installation

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

Usage

@freshbooks/api

See the API README, the full documentation and check out some of our examples.

@freshbooks/app

See the APP README.

Development

Testing

yarn install
yarn build
yarn test

Releasing

  1. Make sure everything is up to date locally
  2. Update CHANGELOG.md and move any changes in "Unreleased" to the new version number
  3. Commit changes and push to origin
  4. Pull latest changes from origin
  5. Update the package versions by executing: ./node_modules/.bin/lerna version
  6. 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.