Ibotta / url_builder_app

A Zendesk App to help you generate links for agents.
Apache License 2.0
10 stars 8 forks source link

Installation Issue #15

Closed sprykebab closed 5 years ago

sprykebab commented 5 years ago

Prerequisites

Please answer the following questions for yourself before submitting an issue.

Expected Behavior

Uploading to Zendesk to install. Followed installation instructions in "README.md"

Current Behavior

After attempting to upload, got the following error:

Failure Information (for bugs)

Upload Error "Could not find manifest.json in the root of the zip file, but src/manifest.json was found. Try re-creating the archive from this directory."

Steps to Reproduce

Please provide detailed steps for reproducing the issue.

  1. Go to Apps >> Manage
  2. Click on "Upload Private App"
  3. Enter App Name & Choose url_builder_app-master.zip
  4. Click on Upload
  5. Shows "Queued...", then the error above

Context

Please provide any relevant information about your setup.

I'm not certain if the project is live yet, so perhaps I'm jumping the gun, but only because the V1 app will be out-of-date on Monday 14th Oct. We already have V1 of the app installed. Is a prerequisite to uninstall that? I'm not a developer and don't have ZAT installed. One google result for a similar error suggested using "zat package" to fix the problem.

Failure Logs (Follow steps to reproduce with Developer Tools open - Usually F12)

Please include any relevant log snippets or files here.

thomashunziker commented 5 years ago

You cannot upload the ZIP as you download it from Github. You have to build the project.

I summaries the steps below to build it: 1) Clone the git repo: git clone git@github.com:Ibotta/url_builder_app.git 2) Change into the directory: cd url_builder_app 2) Run npm install 3) Run npm run build 4) Run zat validate --path=./dest 5) Run zat package --path=./dest

This will produce a ZIP file in ./dist/tmp/app-{date}.zip. Important none of the above step can fail otherwise it will not work.

To execute the above you need the following tools install on your machine:

It would make sense if the maintainer of the project would provide this ZIP file. Most people will not be able to execute the build process.

physik932 commented 5 years ago

We also combined a few of the commands into just npm run package; but @thomashunziker is correct in you need git, nodejs, and ZAT.

I'll work on getting a ZIP uploaded until the public version is up.

physik932 commented 5 years ago

@michaelcavallaro03 and I added a tagged release for V2 here:

https://github.com/Ibotta/url_builder_app/releases/tag/v2.0.0

You can download this ZIP and upload it directly to Zendesk as a Private App.

jgujgu commented 4 years ago

There's a slight typo above, the commands should be

Run zat validate --path=./dist Run zat package --path=./dist

FYI anyone reading, zat is this: https://develop.zendesk.com/hc/en-us/articles/360001075048-Installing-and-using-the-Zendesk-apps-tools#topic_wxt_wqm_1l