Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 1.9 KB

README.md

File metadata and controls

75 lines (46 loc) · 1.9 KB

Knowledge Capture App

🚧 🚧

This knowledge capture app is meant to replace the existing Zendesk Knowledge Capture app with the added feature of using Liferay's homegrown federated search.

Getting Started

Dependencies

Initial Setup

This project uses bundler 2.2.25 to manage Ruby dependencies. Install bundler via gem install bundler.

In the root directory of this app, run bundle install.

To execute Zendesk App Tool ZAT commands, run bundle exec zat.

Run yarn install to install npm dependencies.

Running locally

To serve the app to your Zendesk instance with ?zat=true, run

yarn run watch
yarn run start

Building

To build for the development environment, run

yarn run build:dev

To build the production app, run

yarn run build

Deploying

To check that your app will pass the server-side validation check, run

zat validate --path=dist

If validation is successful, you can upload the app into your Zendesk account by running

zat create --path=dist

To update your app after it has been created in your account, run

zat update --path=dist

Or, to create a zip archive for manual upload, run

zat package --path=dist

Zendesk Garden CSS Components

Zendesk Garden CSS Components are listed dev dependencies. Instead of importing them into the app css bundle, the default behavior is loading the dev dependencies as jsDelivr CDN and injecting into main.html as another <style> tag.