chore: update Pipfile

This commit is contained in:
Eneko Illarramendi 2020-09-02 14:31:44 +02:00
parent b4a6b45645
commit 0d0e00e699
5 changed files with 82 additions and 82 deletions

View file

@ -22,3 +22,22 @@ Going over the example extension's structure:
* migrations.py: Create database tables for your plugin. They'll be created when you run `pipenv run flask migrate`.
... This document is a work-in-progress. Send pull requests if you get stuck, so others don't.
Adding new dependencies
-----------------------
If for some reason your extensions needs a new python package to work, you can add a new package using Pipenv:
```sh
$ pipenv install new_package_name
```
This will create a new entry in the `Pipenv` file.
**But we need an extra step to make sure LNbits doesn't break in production.**
All tests and deployments should run against the `requirements.txt` file so every time a new package is added
it is necessary to run the Pipenv `lock` command and manually update the requirements file:
```sh
$ pipenv lock -r
```

View file

@ -5,11 +5,13 @@ title: Installation
nav_order: 1
---
Installation
============
Download this repo and install the dependencies.
Application dependencies
------------------------
@ -29,10 +31,11 @@ You will need to set the variables in `.env.example`, and rename the file to `.e
![Files](https://i.imgur.com/ri2zOe8.png)
You might also need to install additional packages, depending on the [backend wallets](../guide/wallets.md) you configured.
E.g. when you want to use LND you have to `pipenv install lnd-grpc`.
E.g. when you want to use LND you have to `pipenv run pip install lnd-grpc`.
Take a look at [Polar](https://lightningpolar.com/) for an excellent way of spinning up a Lightning Network dev environment.
Running the server
------------------
@ -48,6 +51,7 @@ if you want to run Flask in debug mode with autoreload
[pipenv]: https://pipenv.pypa.io/
Frontend
--------