Giter VIP home page Giter VIP logo

help-scout-js-sdk's Introduction

Help Scout Developer Platform โ€” Sidebar App Template

This is a basic starter template for building a Help Scout Sidebar App. It uses Vite and React, and it comes with Help Scout's UI Kit and JavaScript SDK pre-installed.

๐Ÿš€ Getting Started

  1. Go to https://github.com/helpscout/app-template and click the green Use this template button โ†’ Create a new repository. Give your new repo a name, and save it.
  2. Go to https://codesandbox.io/ and create an account if you don't have one (you can login with your Github account.)
  3. On CodeSandbox, click on Import repository and select the repository you created in step 1.

The first time you open your repo in CodeSandbox it will take a couple of minutes to build a container and install dependencies. Once that's done, you'll see the code editor on the left and a preview panel of your app on the right.

  1. Hover on the preview panel and click on the Show navigator icon on the top right. This will reveal the URL of your environment. Copy this URL, you'll need it in a few minutes.

  2. On Help Scout, login as an Administrator or Account owner and navigate to Manage -> Apps

  3. Click the Create button at the top (or click here)

  4. Click on Create App, fill out the form as described below, and click Save:

  • App Name: anything you want
  • Callback URL: the URL of your environment you copied previously
  • Secret Key: any text value
  • Mailboxes: select the mailboxes where you want this app to be available in
  1. Go to one of the Mailboxes you selected in the previous step and open a conversation. You should see your app running in the right Sidebar.
  2. Now you can start making changes to your app in CodeSandbox and you should see those changes reflected immediately in Help Scout.

๐Ÿ› ๏ธ Resources

help-scout-js-sdk's People

Contributors

univan0928 avatar

Watchers

 avatar

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.