thematrixrw / odysee-docs

Documentation of odysee.com

Odysee Help Hub - help.odysee.tv

This repo contains the code that powers help.odysee.tv, which is built using Docusaurus 2 and describes how to use the Odysee Frontend.

Table of Contents

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

Usage

Go to the website to interact with the documentation.

Running from Source

Prerequisites

• Git
• Node.js (v16 required)
• npm

1. Clone (or fork) this repository: git clone https://github.com/OdyseeTeam/odysee-docs
2. Change directory into the cloned repository: cd odysee-docs
3. Install the dependencies: npm install
4. Run the web app for development: npm run start

Deploy the web app (experimental)

1. Create a server with a domain name and a reverse proxy https to port 3000.
2. Install pm2, node v16, npm
3. Clone this repo
4. Run npm install to install
5. Run npm run build to build
6. Navigate to build folder: cd build/
7. Set up pm2 to serve build folder: pm2 serve . 3000

Contributing

We ❤️ contributions from everyone and contributions to this project are encouraged. Feedback is always appreciated.

License

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

Security

For security issues, please reach out to [e-mail]