Skip to content

Commit

Permalink
Adding readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rikez committed Dec 3, 2018
1 parent 8e96871 commit 2d4202a
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Boilerplate for Zendesk App Framework v2 using React
# zendesk-webphone-react

The webphone for the zendesk platform

## Includes
* React
Expand All @@ -9,16 +11,6 @@
* SASS compiler
* CSS modules

## How to use it
Start by cloning this repository with `git clone https://github.com/Cloudhuset/Zendesk-React-App-Boilerplate.git`

**From the root folder you can run the following commands:**
Run `npm install` to install node modules
Run `npm run dev` to compile and watch src files for changes
Run `npm run prod` to compile for production. This will minify/uglify your build so it's ready for packaging.

**App folder:**
The app/ folder is where your Zendesk app lives. From in here you will run the ZAT (Zendesk App Tool) commands, to package the app, run development server, etc. Please read the Zendesk documentation if you have questions regarding the structure of this folder, and other things regarding the app framework.
The app/ folder is where your Zendesk app lives. From in here you will run the ZAT (Zendesk App Tool) commands, to package the app, run development server, etc.

## Do you have any ideas?
Please let us know by making an issue here on github. Also feel free to contribute to the development, by making a pull request.

0 comments on commit 2d4202a

Please sign in to comment.