Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.25 KB

Contributing

Git Branch Workflow

This project adheres to GitHub Flow.

Development (Not for customers)

Environments

To use the test environment while developing features for this repository, set the ONEBLINK_APPS_ENVIRONMENT property on the window before using the tenants export:

import { ... } '@oneblink/apps'
window.ONEBLINK_APPS_ENVIRONMENT = 'test'
// exports that required environment based configuration
// (e.g. the URL to make requests to the OneBlink API)
// will now use the "test" environment configuration

Running Locally

This code base is written in TypeScript so it cannot be included locally in an application without a build step. Luckily, we have provided one :)

  1. Allow NPM package to be linked

    npm link

  2. Start the watch process for building the code when changes occur

    npm start

  3. In your application, link to this package instead of a version on NPM

    npm link @oneblink/apps

Release Process

  1. Checkout master

    git checkout master

  2. Get the latest code

    git pull

  3. Start the release process

    npm run release