Use of this software is subject to important terms and conditions as set forth in the License file
Zendesk App Framework SDK
What is it?
The Zendesk App Framework (ZAF) SDK is a JavaScript library that simplifies cross-frame communication between iframed apps and ZAF. See App Framework v2 to learn more.
For development...
You will need:
Then run:
npm install - Install dependencies
npm run build - Build production
npm run build:dev - Build development version of the SDK, omitting minification
npm run server - Serve compiled JavaScript files at http://localhost:9001
Linting
npm run lint
Stats
npm run stats
Testing
npm run test
Version bumping
npm run bump - Bump patch version, e.g. 1.1.1 => 1.1.2
npm run bump:minor
npm run bump:major
Copyright and license
Copyright 2014 Zendesk
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.