Please read our [contribution guidelines](./CONTRIBUTING.md) before getting started.
npm install @ledgerhq/live-app-sdk
Integrate your application or service inside Ledger Live
Full documentation
·
Report Bug
·
Request Feature
Please read our contribution guidelines before getting started.
**You need to have a recent Node.js and
Yarn 1 (Classic) installed.**
``bash`
yarn
Build the SDK
`bash`
yarn build
Check code formatting with
`bash`
yarn format:check
Format source (src) files in-place with
`bash`
yarn format:fix
Check code quality with
`bash`
yarn lint:check
Automatically fix code quality problems with
`bash`
yarn lint:fix
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.
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)yarn publish
- run (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)package.json
- this will update the version in , create a new bump commit, a new tag with the latests version and publish the updated package to npmmain`)
- don't forget to push this newly generated commit as well as the tag (you must have the necessary rights to push to
---