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