Code Monkey home page Code Monkey logo

odysee-docs's Introduction

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.

npm chat on Discord

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

  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.

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]

odysee-docs's People

Contributors

abwasserrohr avatar chris-ody avatar es-socrates avatar jasmindk avatar actions-user avatar liamcdonovan avatar biaoxv avatar tymstudio avatar classicmovies avatar zimm3rmann avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.