react-json-chart-builder

Live editor (docs and examples): https://brumik.github.io/react-json-chart-builder

Intall the npm package

• npm i --save react-json-chart-builder

Workflow

• Write code, commit with semantic release commit messages (see bellow)
• Create PR
• Merge the PR, and the CI will start to run:
  • Generate new package number and tag by semantic release
  • Publish the package to the NPM registry
  • Build the demo app & docs and push it to the gh-pages branch to be served as a webpage
    • Demo: https://brumik.github.io/react-json-chart-builder
    • Docs: https://brumik.github.io/react-json-chart-builder/docs

Semantic release commit messages

Using semantic release: Note, you need the : in it to trigger the release.

• No release: chore(demo): updated the demo application
• Patch release: fix(pencil): stop graphite breaking when too much pressure applied
• Feature release: feat(pencil): add 'graphiteWidth' option
• Breaking release: BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons.

Devel setup

Requirements

• node >= 15
• npm >= 7
• for nvm users you can just do nvm use after nvm install 15 if you had not doen it before

Setup

• npm ci - install the packages
• npm start - start the local web server
• go to localhost:8080

If you want to see the docs too in the browser, you have to generate them first:

• npm run:build:docs

Testing

• npm ci if not done before
• npm test