Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 1.32 KB

CONTRIBUTING

Prerequisites

  • Node (v12.6.x)

Setup

Install dependencies by running npm install && lerna bootstrap what is lerna?

Development

App development

  • run npm start and define the path to configuration file in env variable FEEBAS_DEV_CONFIG or run npm run app:start:fs-local with predefined config. It uses the config from ./packages/desktop_app/integrations/fs-local.

NPM Package Development

  • run npm run lib:dev

Releasing a new versions

  1. run npm version -m "bump version to v%s" major.minor.patch to bump the version (this will bump the version for both, the desktop app and the node library)
  2. run git push --tags to push the created commit and version tag
  3. run npm run app:release to release the app, it will create a draft release on GitHub
  4. via GitHub interface publish the drafted release
  5. run npm run lib:publish to publish the npm package

Debugging

Runtime logs are logged via electron-log.

Also, you can run feebas with the debug flag (npx feebas --debug). This will open the JavaScript console in the application window, also the logs will be print out to your terminal.