From 596167f443ef33cae05371c41a177b0c35193fe7 Mon Sep 17 00:00:00 2001 From: Pavol Rusnak Date: Fri, 30 Aug 2024 13:18:42 +0200 Subject: [PATCH] chore: update install instructions for developers (#2652) --- docs/devs/development.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/devs/development.md b/docs/devs/development.md index b9c71f8c7..ba98dbaff 100644 --- a/docs/devs/development.md +++ b/docs/devs/development.md @@ -11,13 +11,16 @@ Thanks for contributing :) # Run -This starts the lnbits uvicorn server +Follow the [Basic installation: Option 1 (recommended): poetry](https://docs.lnbits.org/guide/installation.html#option-1-recommended-poetry) +guide to install poetry and other dependencies. + +Then you can start LNbits uvicorn server with: ```bash poetry run lnbits ``` -This starts the lnbits uvicorn with hot reloading. +Or you can use the following to start uvicorn with hot reloading enabled: ```bash make dev @@ -25,6 +28,15 @@ make dev poetry 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 +``` + # Precommit hooks This ensures that all commits adhere to the formatting and linting rules.