/lbryweb.go

Primary LanguageGoMIT LicenseMIT

LBRY on the Web

The LBRY experience, in the comfort of your own browser.

Active development is in progress, expect failing tests and breaking changes.

CircleCI Coverage

Running with Docker (if you want to try things)

Make sure you have Docker and docker-compose installed.

Then run:

docker-compose up app

Warning: this will pull and launch lbrynet image, which lbryweb requires to operate

After everything is done launching, open http://localhost:8080 in your browser.

Development (if you want to modify things)

Make sure you have Docker and docker-compose installed.

  1. Run docker-compose up app (or run off the source)
  2. git clone lbry-desktop repo
  3. Run SDK_API_URL=http://localhost:8080/api/proxy/ yarn dev:web in lbry-desktop repo
  4. Open http://localhost:8081/ in Chrome

If you would like to run off the source

You're still going to need lbrynet, so prefix your go commands with docker stuff.

docker-compose up lbrynet --no-start
docker-compose start lbrynet && export LW_LBRYNET=http://localhost:5579/
go mod download
go generate ./...
make embed
LW_DEBUG=1 go run . serve

Testing

Make sure you got lbrynet container running and run make test.

Modifying and building a Docker image

First, make sure you have Go 1.11+

Then build the binary, create a docker image locally and run off it:

make image && docker-compose up app

Contributing

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

Please ensure that your code builds (using ./build.sh) before pushing your branch. You must go fmt your code before you commit it, or the build will fail.

License

This project is MIT licensed. For the full license, see LICENSE.

Security

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

Contact

The primary contact for this project is @lyoshenka (grin@lbry.io).