diff --git a/README.md b/README.md index 924bfa557..7dbea0c9b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# LBRY App - https://lbry.tv +# LBRY App This repo contains the UI code that powers the official LBRY desktop app, as well as lbry.tv. The LBRY app is a graphical browser for the decentralized content marketplace provided by the [LBRY](https://lbry.com) protocol. It is essentially the @@ -92,66 +92,6 @@ You can run the web version (lbry.tv), the electron app, or both at the same tim - If you want to build and launch the production app you can run `yarn build`. This will give you an executable inside the `/dist` folder. We use [electron-builder](https://github.com/electron-userland/electron-builder) to create distributable packages. -#### Run the web app for development - -`yarn dev:web` - -- This uses webpack-dev-server and includes hot-reloading. If you want to debug the [web server we use in production](https://github.com/lbryio/lbry-desktop/blob/master/web/index.js) you can run `yarn dev:web-server`. This starts a server at `localhost:1337` and does not include hot reloading. - -#### Customize the web app - -- In root directory, duplicate the .env.default file and rename it to .env then copy the code below and paste it anywhere in the .env file. - -``` -cp .env.defaults .env -nano .env -``` - -- To specify your own OG-IMAGE - You can either place a png named v2-og.png in the /custom folder or specify the OG_IMAGE_URL in .env - -- To specify your own channels to be followed on first run - `AUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a` - -- If you want to customize the homepage content - -1. add `CUSTOM_HOMEPAGE=true` to the '.env' file -2. copy `/custom/homepage.example.js` to `/custom/homepage.js` and make desired changes to `homepage.js` - -- If you want up to two custom sidebar links - -``` -PINNED_URI_1=@someurl#2/someclaim#4 -PINNED_LABEL_1=Linktext - -PINNED_URI_2=$/discover?t=tag&[queryparams] -PINNED_LABEL_2=OtherLinkText -``` - -- Finally `NODE_ENV=production yarn compile:web` to rebuild - _Note: You don't need to edit the .env file in the /web folder - that is copied during compile._ - -#### Deploy the web app (_experimental_) - -1. Create a server with a domain name and a reverse proxy https to port 1337. -2. Install pm2, node v10, yarn -3. Clone this repo -4. Make any customizations as above -5. Run `yarn` to install -6. Run `NODE_ENV=production yarn compile:web` to build -7. Set up pm2 to start ./web/index.js - -#### Run both at the same time - -Run the two commands above in separate terminal windows - -``` -yarn dev - -// in another terminal window -yarn dev:web -``` - #### Resetting your Packages If the app isn't building, or `yarn xxx` commands aren't working you may need to just reset your `node_modules`. To do so you can run: `rm -r node_modules && yarn` or `del /s /q node_modules && yarn` on Windows.