heierbtc/lnbits
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arc 2019-12-18 11:02:00 +00:00 committed by GitHub
parent 071a23b31e
commit 9322be442d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -41,26 +41,34 @@ Wallets can be easily generated and given out to people at events (one click mul
![lnurl ATM](https://i.imgur.com/SF5KoIe.png) ![lnurl ATM](https://i.imgur.com/SF5KoIe.png)
# Running LNbits locally # Running LNbits locally
## Linux/Mac
Download this repo Download this repo
Install Python libraries LNbits uses [Flask](http://flask.pocoo.org/).
Feel free to contribute to the project.
Flask Application dependencies
`pip3 install flask` ------------------------
The application uses [Pipenv][pipenv] to manage Python packages.
While in development, you will need to install all dependencies:
LNURL $ pipenv shell
`pip3 install lnurl` $ pipenv install --dev
Requests Running the server
`pip3 install requests` ------------------
Run $ flask run
`python3 *folders*/server.py`
## Windows There is an environment variable called `FLASK_ENV` that has to be set to `development`
Meh if you want to run Flask in debug mode with autoreload
Style guide
-----------
Tab size is 4 spaces. Maximum line length is 120. You should run `black` before commiting any change.
$ black lnbits
[pipenv]: https://docs.pipenv.org/#install-pipenv-today
# Tip me # Tip me
If you like this project and might even use or extend it, why not send some tip love! If you like this project and might even use or extend it, why not send some tip love!