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
179 commits 4 branches 0 tags 3.6 MiB
JavaScript 98.5%
Shell 1.5%
Find a file
Mark 8e2c50d232
Merge pull request #143 from filipnyquist/fix-readme 
Added examples and removed deprec. information from README
2019-02-05 10:48:26 -05:00
decoder Removed configuration of decoder, using lbrycrd conf from .lbrycrd. 2017-09-26 17:51:18 +02:00
docs Updated the API doc to add NSFW filtering 2018-10-21 22:41:17 +02:00
server Update lighthouse.js 2018-11-13 13:23:01 -05: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 Added auto-deployment for lighthouse 2018-11-04 01:01:22 -04:00
.travis.yml added slack integration 2018-11-04 01:01:23 -04: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 create LICENSE file 2018-02-05 13:04:58 -08:00
package.json added slack integration 2018-11-04 01:01:23 -04:00
README.md Removed old information from README 2019-02-05 11:12:37 +01:00
swagger.json Added swagger.json documentation instead of jsDoc. This PR also adds ReDoc to our documentation instad of apiDoc. Fixes #97 2018-08-05 15:19:11 +02:00
yarn.lock added slack integration 2018-11-04 01:01:23 -04: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.io

What does Lighthouse consist of?

  1. Elasticsearch as a backend db 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.io/search?s=stringtosearch

To get autocomplete suggestions:

https://lighthouse.lbry.io/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:

yarn install --production=false

Build and run Lighthouse:

yarn 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.io/faq/contributing

License

This project is MIT Licensed © LBRYio, Filip Nyquist

Security

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

Contact

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