heierbtc/lnbits
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e1abea77f5
lnbits/docs/devs/installation.md

61 lines
1.3 KiB
Markdown
Raw Normal View History

feat: use github pages and jekyll for docs
2020-05-04 15:20:36 +00:00
---
layout: default
parent: For developers
title: Installation
nav_order: 1
---
chore: update Pipfile
2020-09-02 12:31:44 +00:00
feat: use github pages and jekyll for docs
2020-05-04 15:20:36 +00:00
Installation
============
Pointed people towards a stable release
2020-10-01 17:12:29 +00:00
Download the latest stable release https://github.com/lnbits/lnbits/releases
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
chore: update Pipfile
2020-09-02 12:31:44 +00:00
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
Application dependencies
------------------------
feat: use github pages and jekyll for docs
2020-05-04 15:20:36 +00:00
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
The application uses [Pipenv][pipenv] to manage Python packages.
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
While in development, you will need to install all dependencies:
```sh
$ pipenv shell
$ pipenv install --dev
```
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
Update installation.md
2020-06-22 14:15:27 +00:00
If you wish to use a version of Python higher than 3.7:
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
Update installation.md
2020-06-22 14:14:51 +00:00
```sh
$ pipenv --python 3.8 install --dev
```
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
update docs so master is runnable.
2020-10-02 17:53:55 +00:00
You will need to copy `.env.example` to `.env`, then set variables there.
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
![Files](https://i.imgur.com/ri2zOe8.png)
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
You might also need to install additional packages, depending on the [backend wallet](../guide/wallets.md) you use.
docs: fix typo in command
2020-10-13 08:31:53 +00:00
E.g. when you want to use LND you have to `pipenv run pip install lndgrpc` and `pipenv run pip install purerpc`.
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Network dev environment.
feat: use github pages and jekyll for docs
2020-05-04 15:20:36 +00:00
chore: update Pipfile
2020-09-02 12:31:44 +00:00
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
Running the server
------------------
migrate from flask to quart. also remove all flaskiness from static file serving. and reference all vendored scripts on the base tempĺate for simplicity.
2020-09-14 00:31:05 +00:00
LNbits uses [Quart][quart] as an application server.
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
```sh
python -m lnbits
2020-09-04 20:13:10 +00:00
$ pipenv run python -m lnbits
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
```
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
Improve setup instructions and README - README cleanups and link to documentation - Improve dev setup instructions - Fix js linting errors - Move local setup instructions to installation docs - Project link fix, closes #42 - Notes about frontend - Clarify different LND backends
2020-06-12 18:58:37 +00:00
Frontend
--------
refactor: add some dev files and `black` original code Original server code has been moved to __init__ file, so we can work on `lnbits` as a package.
2019-12-13 16:56:19 +00:00
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
The frontend uses [Vue.js and Quasar][quasar].
migrate from flask to quart. also remove all flaskiness from static file serving. and reference all vendored scripts on the base tempĺate for simplicity.
2020-09-14 00:31:05 +00:00
[quart]: https://pgjones.gitlab.io/
chore: remove `gunicorn` and `gevent` from minimum requirements It is now up to the user to install these (or other) for production deployment. More info: https://flask.palletsprojects.com/en/1.1.x/tutorial/deploy/#run-with-a-production-server
2020-09-03 17:53:22 +00:00
[pipenv]: https://pipenv.pypa.io/
[polar]: https://lightningpolar.com/
[quasar]: https://quasar.dev/start/how-to-use-vue
Reference in New Issue Copy Permalink