Giter VIP home page Giter VIP logo

project-wisdom's Introduction

dxw note

2024-08-23: this project is no longer used and is now archived.

CI Status JavaScript Style Guide

Project Wisdom

A Zendesk App that fetches contextual information about a ticket from its custom project field.

Prerequisites

To run the app locally, you'll need to have the following installed:

  • Ruby 2.x
  • Node.js 12.13.0 or greater

Getting started

Clone the repo

git clone [email protected]:dxw/project_wisdom.git

Run the setup task

./script/setup

Add the username and password to the .zat file (optional)

Necessary if you want to run the server, but not if all you want is to run the test suite.

Where "username" is your Zendesk login with /token appended to the end (e.g. [email protected]/token), and "password" is available in the dxw 1Password as "Zendesk API Key".

Running the server locally

script/server

You'll need the Airtable API Key and Base Key (available from the dxw 1Password).

Access a ticket

Go to a ticket in Zendesk and append ?zat=true to the url. eg:

https://dxw.zendesk.com/agent/tickets/123345?zat=true

Click on the Apps button on the ticket view to see the app in action!

Running the tests

Run the following script:

script/test

Building and updating the app

To rebuild the app locally following changes, run

script/build

to build the app in the /dist folder using Webpack, and generate a zip file of the project in dist/tmp.

The repo is set up to automatically push to Zendesk on every main push, but in case you want to do this manually and push the updated package to Zendesk, you can run:

script/build --push

This assumes you have the correct credentials in your .zat file.

Adding new fields

When adding new fields, these are the files you will need to look at: default.js, project.js

For the relating spec changes: app.spec.js, project.spec.js

my-project.json is the test data used within the spec files.

project-wisdom's People

Contributors

cristinaro avatar jacksonj04 avatar dependabot[bot] avatar pezholio avatar dependabot-preview[bot] avatar renovate[bot] avatar erbridge avatar beelorna avatar lozette avatar leeky avatar mec avatar rjw1 avatar dxw-rails-user avatar

Watchers

Ed Davey avatar  avatar  avatar James Cloos avatar dxw Deploy avatar Mallory Adams avatar  avatar Anthony O'Malley avatar Sim avatar Stretch avatar Ben Atherton avatar George Eaton avatar  avatar Serena Piccioni avatar

Forkers

lgtm-migrator

project-wisdom's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource Name Replacement PR?
npm @babel/polyfill Unavailable
npm @zendeskgarden/css-arrows Unavailable
npm @zendeskgarden/css-grid Unavailable
npm @zendeskgarden/css-menus Unavailable
npm @zendeskgarden/css-modals Unavailable
npm @zendeskgarden/css-pagination Unavailable
npm @zendeskgarden/css-tables Unavailable
npm @zendeskgarden/css-tabs Unavailable
npm @zendeskgarden/css-tooltips Unavailable
npm @zendeskgarden/css-utilities Unavailable

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • Update dependency @zendeskgarden/css-avatars to v6.0.13
  • Update dependency @zendeskgarden/css-buttons to v8.0.3
  • Update dependency @zendeskgarden/css-callouts to v3.3.20
  • Update dependency @zendeskgarden/css-forms to v7.0.22
  • Update dependency @zendeskgarden/css-tags to v5.1.17
  • Update dependency babel-loader to v9.1.3
  • Update dependency handlebars to v4.7.8
  • Update dependency @zendeskgarden/css-bedrock to v9.1.1
  • Update dependency css-loader to v6.11.0
  • Update dependency foreman to v0.88.1
  • Update dependency standard to v17.1.0
  • Update jest monorepo to v29.7.0 (babel-jest, jest, jest-environment-jsdom)
  • Update actions/checkout action to v4
  • Update actions/setup-node action to v4
  • Update dependency copy-webpack-plugin to v12
  • Update dependency css-loader to v7
  • Update dependency node to v20
  • Update dependency postcss-import to v16
  • Update dependency postcss-loader to v8
  • Update dependency postcss-preset-env to v10
  • Update dependency ruby to v3
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

bundler
Gemfile
  • foreman "~> 0.87"
  • zendesk_apps_tools ">= 3.8.5"
github-actions
.github/workflows/deploy.yml
  • actions/checkout v3
  • actions/setup-node v3
  • ruby/setup-ruby v1
.github/workflows/test.yml
  • actions/checkout v3
  • actions/setup-node v3
  • ruby/setup-ruby v1
nodenv
.node-version
  • node 18.15.0
npm
package.json
  • @babel/runtime ^7.18.9
  • airtable ^0.11.6
  • handlebars ^4.7.7
  • @babel/core ^7.18.9
  • @babel/plugin-transform-runtime ^7.18.9
  • @babel/polyfill ^7.12.1
  • @babel/preset-env ^7.18.9
  • @zendeskgarden/css-arrows ^3.1.4
  • @zendeskgarden/css-avatars ^6.0.11
  • @zendeskgarden/css-bedrock ^9.0.0
  • @zendeskgarden/css-buttons ^8.0.1
  • @zendeskgarden/css-callouts ^3.3.18
  • @zendeskgarden/css-forms ^7.0.21
  • @zendeskgarden/css-grid ^0.1.39
  • @zendeskgarden/css-menus ^9.0.20
  • @zendeskgarden/css-modals ^6.4.21
  • @zendeskgarden/css-pagination ^4.0.19
  • @zendeskgarden/css-tables ^4.0.19
  • @zendeskgarden/css-tabs ^6.0.19
  • @zendeskgarden/css-tags ^5.1.16
  • @zendeskgarden/css-tooltips ^4.1.27
  • @zendeskgarden/css-utilities ^4.5.5
  • babel-core ^7.0.0-bridge.0
  • babel-jest ^29.0.0
  • babel-loader ^9.0.0
  • braces ^3.0.2
  • clean-webpack-plugin ^4.0.0
  • copy-webpack-plugin ^11.0.0
  • css-loader ^6.7.1
  • html-webpack-plugin ^5.5.0
  • jest ^29.0.0
  • jest-environment-jsdom ^29.0.0
  • mini-css-extract-plugin ^2.6.1
  • postcss-import ^15.0.0
  • postcss-loader ^7.0.1
  • postcss-preset-env ^8.3.0
  • precss-v8 ^5.0.1
  • standard ^17.0.0
  • webpack 5.78.0
  • webpack-cli ^4.10.0
  • node >=6.11.5
ruby-version
.ruby-version
  • ruby 2.7.8

  • Check this box to trigger a request for Renovate to run again on this repository

Should bootstrap script install foreman?

Trying to run the server without foreman instructs you to install that gem.

Shouldn't this be part of the bootstrap script?

There might be something I'm missing, which is why I'm making this a question and not a PR. ;)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.