LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Lighthouse - A lightning fast search for the LBRY blockchain
230 commits 4 branches 0 tags 3.6 MiB
JavaScript 98.5%
Shell 1.5%
Find a file
knightwayne b133c987da fixed typo
2019-11-01 05:22:15 +05:30
docs .io to .com 2019-07-08 20:00:10 +02:00
server adjust channel ID lookup 2019-10-31 17:43:07 +01:00
test Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.babelrc Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.editorconfig Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.eslintrc Added the basic structure and fixed some issues! 2017-08-16 19:49:27 +02:00
.gitignore add debugging 2019-10-14 16:40:19 +02:00
.travis.yml .io to .com 2019-07-08 20:00:10 +02:00
chainquery-config.json.example replace API with db connector 2019-10-14 16:40:19 +02:00
CONTRIBUTORS.md Added contributors 2017-09-20 13:17:48 +02:00
gendb.sh Fixed the gendb script for compability with new curl versions. 2018-07-09 14:50:21 +02:00
LICENSE bump year in license 2019-10-08 23:28:49 +03:00
package-lock.json replace API with db connector 2019-10-14 16:40:19 +02:00
package.json replace API with db connector 2019-10-14 16:40:19 +02:00
README.md fixed typo 2019-11-01 05:22:15 +05:30
swagger.json .io to .com 2019-07-08 20:00:10 +02:00

README.md

Lighthouse - A lightning fast search for the LBRY blockchain

Codacy Badge MIT licensed

Lighthouse is a lightning-fast advanced search engine API for publications on the lbrycrd with autocomplete capabilities. The official lighthouse instance is live at https://lighthouse.lbry.com

What does Lighthouse consist of?

  1. Elasticsearch as a backend database server.
  2. LBRYimport, an 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.

API Documentation / Usage example

To make a simple search by string:

https://lighthouse.lbry.com/search?s=stringtosearch

To get autocomplete suggestions:

https://lighthouse.lbry.com/autocomplete?s=stringtocomp

The full API documentation

Installation

Prerequisites

To get started you should clone the git:

git clone https://github.com/lbryio/lighthouse

Make sure elasticsearch is running and run (from the lighthouse dir):

./gendb.sh

Install dependencies:

npm run install --production=false

Build and run Lighthouse:

npm run prod

You are now up and running! You can connect to lighthouse at http://localhost:50005, API documentation is here. Lighthouse will continue syncing in the background. It usually takes ~15 minutes before all claims are up to date in the database.

Contributing

Contributions to this project are welcome, encouraged, and compensated. For more details, see lbry.com/faq/contributing

License

This project is MIT Licensed © LBRYio, Filip Nyquist

Security

We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it.

Contact

The primary contact for this project is @tiger5226 (beamer@lbry.com)