Use of this sample app is subject to our Terms of Use.
NOTE: This Sample App has been updated to use SDK App type credentials instead of JWT App type credentials.
This repo is a Vue.js 2 app generated via the Vue CLI that uses the Zoom Meeting SDK to start and join Zoom meetings and webinars.
To get started, clone the repo:
$ git clone https://github.com/zoom/meetingsdk-sample-vuejs.git
To setup and run the app you will need Yarn.
-
Once cloned, navigate to the
meetingsdk-sample-vuejs
directory:$ cd meetingsdk-sample-vuejs
-
Then install the dependencies:
$ yarn install
-
Open the
meetingsdk-sample-vuejs
directory in your code editor. -
Open the
src/components/HelloWorld.vue
file, and enter values for the variables:NEW: To use the Component View, replace
HelloWorld.vue
withHelloWorldNew.vue
. (TheleaveUrl
is not needed). Also, uncomment the Component View CSS tags and comment out the Client View CSS inpublic/index.html
.Variable Description signatureEndpoint Required, the endpoint url that returns a signature. Get a signature endpoint here. sdkKey Required, your Zoom SDK App Key. You can get yours here. 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 Required for Webinar, optional for Meeting, required for meeting and webinar if registration is required. The email of the user starting or joining the meeting / webinar. passWord Optional, meeting password. Leave as empty string if the meeting does not require a password. registrantToken Required if your meeting or webinar requires registration. Example:
signatureEndpoint = 'http://localhost:4000' sdkKey = 'abc123' meetingNumber = '123456789' role = 0 leaveUrl = 'http://localhost:8080' userName = 'Vue.js' userEmail = '' passWord = '' registrantToken = ''
-
Save
HelloWorld.vue
. -
Run the app:
$ yarn serve
-
Navigate to http://localhost:8080 and click "Join Meeting".
Learn more about Gallery View requirements and see more product screenshots.
The Vue.js Sample App can be easily deployed to GitHub Pages, or another static web hosting service, like an AWS S3 bucket.
-
Create a repo on GitHub.
-
Add the remote to your project:
$ git remote add origin GITHUB_URL/GITHUB_USERNAME/GITHUB_REPO_NAME.git
-
Open the
vue.config.js
file and on line 3 replace/GITHUB_REPO_NAME/
with your GitHub repo name surrounded by slashes like this:/GITHUB_REPO_NAME/
. -
Build your project:
$ yarn build
-
Rename the
dist
folder todocs
-
Git add, commit, and push your project:
$ git add -A
$ git commit -m "deploying to github"
$ git push origin master
-
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.
-
Now your project will be deployed to https://GITHUB_USERNAME.github.io/GITHUB_REPO_NAME.
-
Build your project:
$ yarn build
-
Deploy the complied
/dist
directory to a static web hosting service, like an AWS S3 bucket.
For more advanced instructions on deployment, see the Vue.js Deployment docs.
If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.