Updates README
This commit is contained in:
parent
f9266a6efc
commit
09fa4ed27d
1 changed files with 37 additions and 25 deletions
42
README.md
42
README.md
|
@ -1,30 +1,44 @@
|
||||||
# LBRY Comment Server v2
|
# LBRY Comment Server
|
||||||
|
|
||||||
This is a rewrite & update of the server
|
|
||||||
[written by myself and Grayson Burton here](https://github.com/ocornoc/lbry-comments)
|
|
||||||
|
|
||||||
### Install & Setup
|
## Installation
|
||||||
|
|
||||||
Clone the repo and install a virtual environement:
|
Firstly you'll need to install and run the `lbrynet` daemon,
|
||||||
|
the details of which can be found [here](https://github.com/osilkin98/lbryio/lbry).
|
||||||
|
|
||||||
|
Installing the server:
|
||||||
```bash
|
```bash
|
||||||
# clone the repo
|
|
||||||
$ git clone https://github.com/osilkin98/comment-server
|
|
||||||
|
|
||||||
# create a virtual environment in any (current) version of python3.X
|
$ git clone https://github.com/osilkin98/comment-server
|
||||||
|
$ cd comment-server
|
||||||
|
|
||||||
|
# create a virtual environment
|
||||||
$ virtualenv --python=python3 venv
|
$ virtualenv --python=python3 venv
|
||||||
|
|
||||||
|
# Enter the virtual environment
|
||||||
$ source venv/bin/activate
|
$ source venv/bin/activate
|
||||||
|
|
||||||
# install the dependencies
|
# install the library dependencies
|
||||||
(venv) $ pip install -r requirements.txt
|
(venv) $ pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the server
|
## Usage
|
||||||
|
|
||||||
Just run:
|
|
||||||
`(venv) $ python -m src.main.py`
|
|
||||||
and it should run automatically.
|
|
||||||
|
|
||||||
|
First, make sure that the LBRY API server is running,
|
||||||
|
to do so you can run the following:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
(venv) $ curl --data '{ "method": "status"}' http://localhost:5279/ | grep is_running
|
||||||
|
|
||||||
|
# Or from the lbrynet virtual environment:
|
||||||
|
(lbry-venv) $ lbrynet status | grep is_running
|
||||||
|
```
|
||||||
|
|
||||||
|
Then to start the server, simply run:
|
||||||
|
```bash
|
||||||
|
(venv) $ python -m main &
|
||||||
|
```
|
||||||
|
|
||||||
## Schema
|
## Schema
|
||||||
![schema](schema.png)
|
![schema](schema.png)
|
||||||
|
@ -45,5 +59,3 @@ As pointed out by several people, Python is a dinosaur
|
||||||
in comparison to SQLite's execution speed,
|
in comparison to SQLite's execution speed,
|
||||||
so there is no sensibility in multi-threading from the
|
so there is no sensibility in multi-threading from the
|
||||||
perspective of the server code itself.
|
perspective of the server code itself.
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue