Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 3.94 KB

README.md

File metadata and controls

99 lines (69 loc) · 3.94 KB
Raw

Odysee Frontend

The code that runs odysee.com.

npm chat on Discord

Table of Contents

  1. Usage
  2. Running from Source
  3. Contributing
  4. License
  5. Security

Usage

Go to the website to interact on this frontend.

Running from Source

Prerequisites

  1. Clone (or fork) this repository: git clone https://github.com/OdyseeTeam/odysee-frontend
  2. Change directory into the cloned repository: cd odysee-frontend
  3. 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 run yarn dev:web-server. This starts a server at localhost:1337 and does not include hot reloading.

Customization and troubleshooting

    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 the OG_IMAGE_URL in .env file.
    • 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:
      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.
    • 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.
    Deploy the web app
    1. Create a server with a domain name and a reverse proxy https to port 1337.
    2. Install pm2, node v18.14.2, 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.
    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.

contributions welcome GitHub contributors

License

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

Security

For security issues, please reach out to [email protected]