For developers

Thanks for contributing :)

Run

Follow the Option 2 (recommended): UV guide to install uv and other dependencies.

Then you can start LNbits uvicorn server with:

uv run lnbits

Or you can use the following to start uvicorn with hot reloading enabled:

make dev
# or
uv run lnbits --reload

You might need the following extra dependencies on clean installation of Debian:

sudo apt install nodejs
sudo apt install npm
npm install
sudo apt-get install autoconf libtool libpg-dev

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:

uv sync --all-extras --dev
npm i

Then to run the tests:

make test

Run formatting:

make format

Run mypy checks:

make mypy

Run everything:

make all