Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aarontravass/zoom-angular-sdk
https://github.com/aarontravass/zoom-angular-sdk
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/aarontravass/zoom-angular-sdk
- Owner: aarontravass
- Created: 2020-11-01T11:48:55.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-01T11:50:01.000Z (about 4 years ago)
- Last Synced: 2024-10-08T02:44:09.393Z (about 1 month ago)
- Language: TypeScript
- Size: 141 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zoom Web SDK Sample Angular
This repo is an [Angular](https://angular.io/) app generated via the [Angular CLI](https://cli.angular.io/) that uses the [Zoom Web SDK](https://marketplace.zoom.us/docs/sdk/native-sdks/web) to start and join Zoom meetings and webinars.
## Installation
To get started, clone the repo:
`$ git clone https://github.com/zoom/websdk-sample-angular.git`
## Setup
1. Once cloned, navigate to the `websdk-sample-angular` directory:
`$ cd websdk-sample-angular`
1. Then install the dependencies:
`$ npm install`
1. Open the `websdk-sample-angular` directory in your code editor.
1. Open the `src/app/app.component.ts` file, and enter values for the variables:
| Variable | Description |
| -----------------------|-------------|
| signatureEndpoint | Required, the endpoint url that returns a signature. [Get a signature endpoint here.](https://github.com/zoom/websdk-sample-signature-node.js) |
| apiKey | Required, your Zoom JWT App API Key. [You can get yours here](https://marketplace.zoom.us/develop/create). |
| meetingNumber | The Zoom Meeting / webinar number. |
| role | Required, 0 to join the meeting / webinar, 1 to start the meeting. |
| leaveUrl | Required, the url the user is taken to once the meeting is over. |
| userName | Required, A name for the user joining / starting the meeting / webinar. |
| userEmail | Optional, the user joining / starting the meeting / webinar. |
| passWord | Optional, meeting password. Leave as empty string if the meeting does not require a password. |
Example:
```js
signatureEndpoint = 'http://localhost:4000'
apiKey = 'xu3asdfaJPaA_RJW2-9l5_HAaLA'
meetingNumber = 123456789
role = 0
leaveUrl = 'http://localhost:4200'
userName = 'Angular'
userEmail = ''
password = ''
```
1. Save `app.component.ts`.
1. Run the app:
`$ ng serve --open`
## Usage
1. Navigate to http://localhost:4200.
1. Click "Join Meeting" to join the meeting number specified in `src/app/app.component.ts`.
## Deployment
The Angular Sample App can be easily deployed to [GitHub Pages](#github-pages), or [another static web hosting service](#other-static-web-hosting), like an AWS S3 bucket.
### GitHub Pages
1. Create a repo on [GitHub](https://github.com).
1. Add the remote to your project:
`$ git remote add origin GITHUB_URL/GITHUB_USERNAME/GITHUB_REPO_NAME.git`
1. Open the `angular.json` file and on line 48 replace `/` with your GitHub repo name surrounded by slashes like this: `/GITHUB_REPO_NAME/`.
1. Build your project:
`$ ng build --prod`
1. Git add, commit, and push your project:
`$ git add -A`
`$ git commit -m "deploying to github"`
`$ git push origin master`
1. On GitHub, in your repo, navigate to the "settings" page, scroll down to the "GitHub Pages" section, and choose the "master branch /docs folder" for the source.
1. Now your project will be deployed to https://GITHUB_USERNAME.github.io/GITHUB_REPO_NAME.
### Other Static Web Hosting
1. Build your project:
`$ ng build --prod`
1. Deploy the complied `/docs` directory to a static web hosting service, like an AWS S3 bucket.
## Need Support?
The first place to look for help is on our [Developer Forum](https://devforum.zoom.us/), where Zoom Marketplace Developers can ask questions for public answers.
If you can’t find the answer in the Developer Forum or your request requires sensitive information to be relayed, please email us at [email protected].