AdrienPoupa / app_scaffolds

Scaffold templates for developers to build ZAF v2 apps using ZCLI

Use of this software is subject to important terms and conditions as set forth in the License file

App Scaffolds

Description

This repo contains various scaffolds to help developers build apps for Zendesk products.

Getting Started

Dependencies

• Node.js >= 18.12.1
• Ruby = 2.6.x

Setup

1. Clone or fork this repo
2. Change (cd) into the app_scaffolds directory
3. Run yarn install
4. packages/react contains react app scaffold. Please follow React README
5. packages/basic contains basic app scaffold. Please follow Basic README

To run your app locally in Zendesk, you need the latest Zendesk Command Line Interface (ZCLI).

Contribute

• Put up a PR into the master branch.
• CC and get a +1 from @zendesk/vegemite.

Bugs

Submit Issues via GitHub or email [e-mail].

Useful Links

Links to maintaining team, confluence pages, Datadog dashboard, Kibana logs, etc

• https://developer.zendesk.com/
• https://github.com/zendesk/zendesk_apps_tools
• https://webpack.github.io
• https://developer.zendesk.com/documentation/apps/build-an-app/using-react-in-a-support-app/

Copyright and license

Copyright 2018 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.