@dytesdk/api-client v0.1.0

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Support
• License
• About

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm
• NodeJS

Installation

1. Clone the repo

git clone https://github.com/dyte-io/express-backend-sample.git

2. Install NPM packages

npm install

3. Add a .env on the root of the repo, with the following variables:

DYTE_API_KEY=<Your dyte api key>
DYTE_ORG_ID=<Your dyte org id>

4. To run the backend in dev mode (hot reload on changes), run:

npm run dev

To run the backend in production mode, run

npm run build
npm start

Usage

The APIs in this sample actually the v2 API route structure, and returns the response returned from the respective v2 API.

To proceed with this guide, make sure you've already created an account at https://dev.dyte.io and you've created a preset for participants you're going to be adding to meetings via the preset editor.

You can use the authToken you create from this sample in all our other SDKs, such as:

https://github.com/dyte-io/react-samples

• react-samples
• angular-samples
• html-samples
• electron-samples

Here are the APIs used in this sample:

• Create a meeting
• Add a participant to a meeting
• Fetch all presets

Create a Meeting

Creates a meeting in your organization.

Request body schema:

z.object({
  title: z.string().optional(),
});

Reference

Add a participant to a meeting

Adds a participant to a specific meeting.

Request body schema:

z.object({
  name: z.string(),
  picture: z.string().optional(),
  preset_name: z.string(),
});

Reference

Fetch all presets

Fetches all preset names in your organization.

Reference

Using as an executable

To make development easier, you can also use this sample as an npm executable!

Just make sure you have your environment variables in a .env file, and then simply run:

npx @dytesdk/api-client

This will start a development server without needing to clone this repository.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Sincere thanks to all our contributors. Thank you, contributors!

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md and code of conduct at CODE_OF_CONDUCT.md while contributing to the project :smile:.

Support

Contributions, issues, and feature requests are welcome! Give a ⭐️ if you like this project!

License

Distributed under the Apache License, Version 2.0. See LICENSE for more information.

About

express-backend-sample is created & maintained by Dyte, Inc. You can find us on Twitter - @dyte_io or write to us at dev [at] dyte.io. The names and logos for Dyte are trademarks of Dyte, Inc. We love open source software! See our other projects and our products.