Skip to content

README-DEV.md

Latest commit

 

History

History
28 lines (20 loc) · 1.15 KB

README-DEV.md

File metadata and controls

28 lines (20 loc) · 1.15 KB

Harmony TypeScript Development

This mono-repository contains the TypeScript packages of Mobile Jazz Harmony framework.

Initial Setup

  • Ensure NVM is installed on your system
  • nvm install: install the NodeJS version required by Harmony TS
  • nvm use: ensure we're using the proper NodeJS version
  • npm run setup:
    • install dependencies
    • bootstrap: replace internal modules as symlinks and deduplicate packages installing them on root node_modules
    • build packages

Anytime you're working in the project ensure you nvm use to stay on the correct NodeJS version.

Before publishing a new version

  • Always adapt the examples under /examples to match and implement the new changes.
  • For further instructions about working with the examples, please follow their READMEs.

Publish new version

  • git checkout master: ensure you're on master
  • nvm use: ensure we're using the proper NodeJS version
  • npm whoami: ensure you're using the correct NPM user (npm login if not)
  • npm run publish: run at root package.json