LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated documentation with more information!

Browse source 
Updated README.md with instructions on how to run and some license fixes!
This commit is contained in:
filipnyquist 2017-10-16 22:26:13 +02:00 • committed by GitHub
parent 3351b76775
commit 7b53c3a068
1 changed files with 30 additions and 21 deletions

51
README.md
View file

@ -1,5 +1,5 @@
# Lighthouse - A lightning fast search for the LBRY blockchain # Lighthouse - A lightning fast search for the LBRY blockchain
**Created by _filipnyquist_ <filip@lbry.io> and _billbitt_ <bill@lbry.io>** **Created by _filipnyquist_ <filip@lbry.io> and the community!**
## What is Lighthouse? ## What is Lighthouse?
>Lighthouse is a lightning-fast advanced search engine API for publications on the lbrycrd with autocomplete capabilities. >Lighthouse is a lightning-fast advanced search engine API for publications on the lbrycrd with autocomplete capabilities.
@ -9,36 +9,45 @@
>1. Elasticsearch as a backend db server. >1. Elasticsearch as a backend db server.
>2. LBRYimport, a importer that imports the claims into the Elasticsearch database. >2. LBRYimport, a importer that imports the claims into the Elasticsearch database.
>3. Lighthouse API server, which serves the API and does all calculations about what to send to the end user. >3. Lighthouse API server, which serves the API and does all calculations about what to send to the end user.
## DEVELOPMENT NOTES:
> Stuff needed to be worked on are located in issues or in the project board.
## API Documentation ## API Documentation
[The full API documentation](https://lbryio.github.io/lighthouse/) [The full API documentation](https://lbryio.github.io/lighthouse/)
## Running ## Running Lighthouse
Install dependencies ### Prerequisites
* Node v8
* Yarn
* Python2.7
* [Elasticsearch](https://www.elastic.co/downloads/elasticsearch)
>To get started you should clone the git:
```
git clone https://github.com/lbryio/lighthouse
```
>Grab the latest release of lbrycrd here:
[Download lbrycrd](https://github.com/lbryio/lbrycrd/releases)
>Create a lbrycrd config file at ~/.lbrycrd/lbrycrd.conf which contains rpcuser,rpcpassword and rpcport. Then run lbrycrd in the background with that config file.
>Make sure elasticsearch is running and run(from the lighthouse dir):
```
./gendb.sh
```
>Install dependencies:
``` ```
yarn install --production=false yarn install --production=false
``` ```
>Start a instance of the decoder:
Start a Local Server
``` ```
npm start cd decoder && pip install -r requirements.txt && python decoder.py
``` ```
>Build and run Lighthouse:
Run Test
``` ```
npm test yarn run prod
``` ```
>WOO! You are now up and running! You can connect to lighthouse at http://localhost:50005, api documentation is [here](https://lbryio.github.io/lighthouse/).
Building and Running Production Server Lighthouse will continue syncing in the background so it could take approx 10-15minutes before all claims are up to date in database.
```
npm run prod
```
**Note : Please make sure your elasticsearch server is running before using ```npm start``` or ```npm run prod```**
## License ## License
MIT &copy; [LBRYio, Filip Nyquist, Bill Bittner](https://github.com/lbryio) MIT &copy; [LBRYio, Filip Nyquist](https://github.com/lbryio)