.github | ||
.tx | ||
build | ||
custom | ||
electron | ||
extras | ||
flow-typed | ||
homepages | ||
static | ||
ui | ||
web | ||
.env.defaults | ||
.eslintignore | ||
.eslintrc | ||
.flowconfig | ||
.gitignore | ||
.lintstagedrc.json | ||
.prettierignore | ||
.prettierrc.json | ||
.sentryclirc | ||
babel.config.js | ||
config.js | ||
CONTRIBUTING.md | ||
electron-builder.json | ||
LICENSE | ||
package.json | ||
postcss.config.js | ||
README.md | ||
webpack.base.config.js | ||
webpack.electron.config.js | ||
yarn.lock |
Odysee Frontend - Odysee.com
This repo contains the UI and front end code that powers Odysee.com.
Table of Contents
Usage
Go to the website to interact on this frontend.
Running from Source
Prerequisites
- Clone (or fork) this repository:
git clone https://github.com/OdyseeTeam/odysee-frontend
- Change directory into the cloned repository:
cd odysee-frontend
- Install the dependencies:
yarn
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 runyarn 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 as.env
and make customizations there.cp .env.defaults .env nano .env
- To specify your own OG-IMAGE:
- Either place a png named
v2-og.png
in the/custom
folder or specify theOG_IMAGE_URL
in .env file.
- Either place a png named
- To specify your own channels to be followed on first run:
AUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a
- 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
.
- Add
- Finally, run
NODE_ENV=production yarn compile:web
to rebuild.- Note: You do not need to edit the
.env
file in the/web
folder - that is copied during compilation.
- Note: You do not need to edit the
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
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
Contributing
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
License
This project is MIT licensed. For the full license, see LICENSE.
Security
For security issues, please reach out to security@odysee.com