208017c7f5
Added LBRY Inc remover :) See merge request romanrex19/madiator.com!2 |
||
---|---|---|
.tx | ||
build | ||
custom | ||
electron | ||
flow-typed | ||
homepages | ||
static | ||
ui | ||
web | ||
.env.defaults | ||
.eslintignore | ||
.eslintrc | ||
.flowconfig | ||
.gitignore | ||
.lintstagedrc.json | ||
.prettierrc.json | ||
.sentryclirc | ||
add | ||
babel.config.js | ||
CHANGELOG.md | ||
config.js | ||
CONTRIBUTING.md | ||
diff | ||
electron-builder.json | ||
LICENSE | ||
package.json | ||
postcss.config.js | ||
README.md | ||
webpack.base.config.js | ||
webpack.electron.config.js | ||
yarn.lock |
madiator.com - https://madiator.com
This repo contains the UI code that powers the official LBRY desktop app, as well as madiator.com (fork of LBRY.tv). The LBRY app is a graphical browser for the decentralized content marketplace provided by the LBRY protocol. It is essentially the lbry daemon bundled with a UI using Electron.
Running from Source
You can run the web version (madiator.com), the electron app, or both at the same time.
Prerequisites
- Clone (or fork) this repository:
git clone https://gitlab.com/romanrex19/madiator.com
- Change directory into the cloned repository:
cd madiator.com
- Install the dependencies:
yarn
Run the electron app
To remove LBRY Inc use:
git apply diff
Tu run app:
yarn dev
- 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 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 you can run
yarn dev:web-server
. This starts a server atlocalhost: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
-
If you want to customize the homepage content
- add
CUSTOM_HOMEPAGE=true
to the '.env' file - copy
/custom/homepage.example.js
to/custom/homepage.js
and make desired changes tohomepage.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)
- Create a server with a domain name and a reverse proxy https to port 1337.
- Install pm2, node v10, yarn
- Clone this repo
- Make any customizations as above
- Run
yarn
to install - Run
NODE_ENV=production yarn compile:web
to build - 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.
If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r
License
This project is MIT licensed. For the full license, see LICENSE.