https://github.com/ekaansharora/agora-electron-demo
https://github.com/ekaansharora/agora-electron-demo
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ekaansharora/agora-electron-demo
- Owner: EkaanshArora
- Created: 2020-07-07T20:00:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T12:56:24.000Z (over 2 years ago)
- Last Synced: 2025-02-03T14:47:22.853Z (3 months ago)
- Language: JavaScript
- Size: 1020 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agora Electron Quickstart
A barebones quickstart app for group video calls on Electron using Agora.io SDK.
## Prerequisites
* A recent version of Node.js and NPM/Yarn
* A valid Agora account ([Sign up](https://dashboard.agora.io/) for free)
Open the specified ports in Firewall Requirements if your network has a firewall.
## Running this example project
### Structure
```
.
├── src
│ └── index.css
│ └── index.html
│ └── index.js
│ └── render.js
├── package.json
.
```
### Generate an App ID
In the next step, you need to use the App ID of your project. Follow these steps to [create an Agora project](https://docs.agora.io/en/Agora%20Platform/manage_projects?platform=All%20Platforms) in Console and get an [App ID](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#a-nameappidaapp-id ).
1. Go to [Console](https://dashboard.agora.io/) and click the **[Project Management](https://dashboard.agora.io/projects)** icon on the left navigation panel.
2. Click **Create** and follow the on-screen instructions to set the project name, choose an authentication mechanism (for this project select App ID without a certificate), and Click **Submit**.
3. On the **Project Management** page, find the **App ID** of your project.
Check the end of document if you want to use App ID with certificate.
### Steps to run our example
* Download and extract the zip file from the master branch.
* Run yarn install or use npm to install the app dependencies in the unzipped directory.
* Navigate to `./src/render.js` and edit line 2 to enter your App ID that we generated.
* Open a terminal and execute `yarn start` or `npm run start`.
The app uses `channel-x` as the channel name.