Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 684 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 684 Bytes

Contributing

  1. Fork and clone the repository

Developing the server

In the root of the project, run

npm install
npm start

Developing the CLI

In the root of project, run

./bin/cli.sh help

Or, to run anywhere, start watch-building and link the project

npm link .
npm run watch
# cd anywhere-else
jpx version

Developing the UI

In the ui directory, run

cd ui
npm install
npm start

Releasing a new version

Run the release script from the root of the project.

./bin/release.sh

Contributing to Docs

If viewing docs in the app, you need to re-run npm start for markdown changes to take effect.