Javascript Plugin Template by Dyte

Explore the docs »

Report Bug • Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Publish Your Plugin
• Contributing
• License

About The Project

Plugin SDK let's you build custom plugins that work with all of Dyte's core SDKs.

Built With

• Dyte
• Typescript

Getting Started

Prerequisites

• npm
• node

Installation

• Clone the repo

  git clone https://github.com/dyte-in/js-plugin-template.git
  
  cd plugin-template-js
  

• Install NPM packages

  npm install
  

• Run the project

  npm start
  

Usage

Once you have started the dev server using npm start, open http://staging.dyte.in, and use the LocalhostDev plugin. You will now be able to see your plugin inside the meeting stage (this will be accessible only from localhost:5000).

Publish Your Plugin

You can use Dyte CLI to create and publish plugins.

• Installation: https://docs.dyte.io/cli/installation
• Configuration: https://docs.dyte.io/cli/getting-started
• Publishing Plugins: https://docs.dyte.io/cli/plugins

The complete documentation and usage for Plugin SDK can be found at: https://www.npmjs.com/package/@dytesdk/plugin-sdk#usage

Contributing

We really appreciate contributions in the form of bug reports and feature suggestions. Help us make Dyte better with your valuable contributions on our forum 🙂.

License

Distributed under the MIT License. See LICENSE for more information.