Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.56 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.56 KB
Raw

Tribe Helpdesk Scripts

Customizations written for the LiveAgent support portal.

LiveAgent actually allows any administrator to modify our custom JS and CSS 'at will', however this repository exists so that we can more easily track, review and polish our work before it goes live. Using version control for these assets also allows us to easily roll things back to an earlier revision if we make a mistake.

⚠ Bottom line: all changes to our custom LiveAgent JS and CSS need to flow through this repository!

Get started

  • Install everything you need with npm install
  • To compile, use:
    • gulp scripts (JS only)
    • gulp styles (CSS only)
    • gulp build (JS and CSS)
    • gulp watch (to rebuild any time a change is detected)

Structure

  • Global definitions belong in global/ ... any files in here will be loaded first
  • Third party libraries belong in vendor/ ... any files in here will be loaded next of all
  • Our main JS should live in includes/ ... files in here will be loaded last of all
  • Everything is automatically wrapped - and executes within - a function that runs when the document is ready and within which $ acts as an alias for jQuery

Local Development and Testing

Since LiveAgent is a third party platform, developing locally can be a challenge. For that reason we have a copy of the production site contained within the docs/ directory (so named to support a convention used by GitHub Pages).

Helper commands (assumes you are in the root directory of this repo):

  • npm run local-server starts a local server which you can use to test out your changes locally
  • bash utilities/rebuild-local-copy will wipe the docs/ folder and rebuild it using the latest production sources
  • bash utilities/fix-docs-dir-permissions may be useful if your local Gulp has difficulties writing to the docs/ folder
  • bash utilities/view-static-site will try to open the local site in your default browser however this is no longer recommended: use the local server instead

To utilize these tools you will need Docker. Note too that each time you run gulp build the resulting artifacts—the compiled JS and CSS—will also be copied across to the docs/ directory.

Workflow for changes

  • Create a feature (or fix) branch
  • Ensure you recompile!
  • Test things out on a spare LiveAgent install if appropriate
  • Submit a pull request

Deployment

  • Once you have merged your pull request into master, run bot update liveagent frontend in Slack to deploy the changes. Note: S3 caching may cause a slight delay in seeing the changes live.