GlcoinCore/blitz_api
1
0
Fork 0
mirror of https://github.com/fusion44/blitz_api.git synced 2026-08-13 11:52:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #1 from cstenglein/main

Browse source 
add installation instructions to README
This commit is contained in:
fusion44 2021-07-17 21:42:19 +02:00 • committed by GitHub
commit 48ee10f532
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1 +1,25 @@
# blitz_api
## Configuration
Update the `.env` file with your `bitcoind` and `lnd` configuration.
Please note that you will also need to install [Redis](https://redis.io/).
If you need a easy option to run a simple bitcoind & lnd client, [Polar](https://github.com/jamaljsr/polar) makes that pretty easy.
## Installation
You will need to have [Python in version 3](https://www.python.org/downloads/) installed and have the `.env` see [Configuration](#Configuration) configured correctly first.
To install the dependencies, run
`python -m pip install -r requirements.txt` on Linux / macOS or
`py -m pip install -r requirements.txt` on Windows.
After that, you can run the application with
`python -m uvicorn main:app --reload` on Linux / macOS or
`py -m uvicorn main:app --reload` on Windows.