backend-sample-app by dyte
A NodeJS backend to interact with the Dyte REST API
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
- Table of Contents
- About The Project
- Getting Started
- Usage
- Roadmap
- Contributing
- Support
- License
- About
About The Project
This is a sample backend application which interacts with the REST API.
Built With
Getting Started
Deploy directly to heroku using this button!
To get a local copy up and running follow these simple steps.
Prerequisites
- npm
- NodeJS
Installation
- Clone the repo
git clone https://github.com/dyte-in/backend-sample-app.git
- Install NPM packages
npm install
- Add a
.env
on the root of the repo, with the following variables:
PORT=3001
DYTE_API_BASE=https://api.cluster.dyte.in/v1
DYTE_API_KEY=<Your dyte api key>
DYTE_ORG_ID=<Your dyte org id>
- 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 backend exposes an express API server with the following routes:
Route | Method | JSON Body Params | Description |
---|---|---|---|
/meeting/create | POST | { |
Create a meeting. For more details, see https://docs.dyte.io/api/#/operations/createMeeting |
/participant/create | POST | { Note: Pass only one of presetName or roleName, NOT both. |
Create a participant for a meeting. For more details, see https://docs.dyte.io/api/#/operations/addParticipant |
/meetings | GET | N/A | Get the list of all meetings in the organization. For more details, see https://docs.dyte.io/api/#/operations/getAllMeetings |
/preset/get | GET | N/A | Get the list of all the presets in the organization. For more details, see https://docs.dyte.io/api/#/operations/getAllPresets |
Roadmap
See the open issues for a list of proposed features (and known issues).
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 😄.
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
backend-sample-app
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.