Live App SDK

Integrate your application or service inside Ledger Live

Full documentation
·
Report Bug
·
Request Feature

Contributing

Please read our contribution guidelines before getting started.

**You need to have a recent Node.js and
Yarn 1 (Classic) installed.**

$3

``bash
yarn
`

$3

Build the SDK

`bash
yarn build
`

$3

Check code formatting with

`bash
yarn format:check
`

Format source (src) files in-place with

`bash
yarn format:fix
`

$3

Check code quality with

`bash
yarn lint:check
`

Automatically fix code quality problems with

`bash
yarn lint:fix
`

Documentation

You can generate the project's documentation, either in html or in markdown.

For markdown use:

`bash
yarn doc
`

For html use:

`bash
yarn doc:html
`

The documentation will be generated in a docs/reference or docs/html folder depending on the chosen format.

You can find the entrypoint to the generated doc here.

Publish

This generated package is hosted on NPM here.

⚠️ Publishing can only be performed by members of the _ledgerhq_ organization having the necessary rights to push to main branch ⚠️

In order to publish a new version of this package, please refer to the following steps:

- create and setup you npm account (cf. npm doc) (you must be part of the _ledgerhq_ organization to publish)
- run yarn publish (cf. doc) on the commit / branch you want to publish (usually the main branch) (you will have to specify the new package version, following semver standard)
- this will update the version in package.json, create a new bump commit, a new tag with the latests version and publish the updated package to npm
- don't forget to push this newly generated commit as well as the tag (you must have the necessary rights to push to main`)

---

We are hiring, join us! 🚀

$3

- Ledger Live