README.md

Pangolin.js Visual Review

About

Pangolin.js Visual Review is inspired by GitLab Visual Reviews. But GitLab’s solution is only available for paid GitLab and I wanted to create something similar which also connects to different backends – currently GitHub and GitLab.

Without further ado: What the heck is Pangolin.js Visual Review?

It allows the creation of issues directly from any website. Some browser metrics will be attached to the issue body automatically, for example the URL, user agent, and viewport size. The developers don’t have to run around and collect these information and the issue reporters don’t have to learn browser insides.

Take a look at the GitHub and GitLab demos. Search for a little button in the bottom right corner 🙂

Getting started

Using Pangolin.js Visual Review is as easy as including a script from a CDN in your website:

<script
  data-backend-type="BACKEND_TYPE"
  data-backend-url="BACKEND_URL"
  data-repository="OWNER/NAME"
  id="pangolinjs-visual-review"
  src="http://cdn.jsdelivr.net/npm/@pangolinjs/visual-review"
  defer
></script>

Available backend types

• GitHub
• GitLab

Development

Pangolin.js Visual Review is developed by Fynn Becker and released under the MIT License.

Start a dev server with auto-reload:

npm run dev

Build production-ready minified bundle:

npm run build

Lint JavaScript code:

npm run lint