For developers

Thanks for contributing :)


This starts the lnbits uvicorn server

poetry run lnbits

This starts the lnbits uvicorn with hot reloading.

make dev
# or
poetry run lnbits --reload

Precommit hooks

This ensures that all commits adhere to the formatting and linting rules.

make install-pre-commit-hook


This project has unit tests that help prevent regressions. Before you can run the tests, you must install a few dependencies:

poetry install
npm i

Then to run the tests:

make test

Run formatting:

make format

Run mypy checks:

poetry run mypy

Run everything:

make all

Table of contents