gleapsdk / javascript-sdk Goto Github PK

Gleap helps developers build the best software faster. It is your affordable in-app bug reporting tool for apps, websites and industrial applications.

License: MIT License

JavaScript 99.98% HTML 0.02%

feedback-button javascript sdk bugreports bug bugtracking bugtracker

javascript-sdk's Introduction

Gleap JavaScript SDK

Welcome to the Gleap JavaScript SDK. Enhance your platform with features like Kai, our advanced GPT-4 AI chatbot, intuitive outbound messaging tools, and a comprehensive Help Center. Explore our toolkit designed for efficient and engaging customer interactions. Join us in setting new standards for user experience in the digital age. Let's code, innovate, and grow together!

📖 Docs & Examples

Checkout our documentation for full reference.

🚀 Getting started

1.) Register an account at www.gleap.io. It's free and takes just a few seconds.

2.) Include the Gleap JS SDK within your apps.

Installation via nom

Install the Gleap package via npm or yarn.

npm install gleap --save

Import the Gleap package.

import Gleap from 'gleap';

Initialize the SDK

Add the following code to initialize the Gleap JavaScript SDK. Replace "SDK-TOKEN" with your actual SDK token from the Gleap dashboard.

Gleap.initialize("SDK-TOKEN");

Congrats, you are now all set! Report your first bug by using the feedback button.

🤝 Need help?

We are here to help! [email protected]

javascript-sdk's People

Contributors

Stargazers

Watchers

Forkers

junekpavel

javascript-sdk's Issues

Network logging not working

Version: "bugbattle": "^3.3.0",

Using the following to enable network logging does not work.
In the Bugbattle dashboard, the the network logging is not captured and tells you to still enable the logging.

BugBattle.enableNetworkLogger();

Feature Request: more characters of the description used for Trello Title

Hi there,

since Trello has almost no limit in regards to title length, it seems pretty harsh to cut the title mid word to 15 char.
See example below.

The way its implemented now, we need to edit each cards title after reporting the bug to get a good overview.
Extending the title limit to either the first Sentence and/or take the first few words could eliminate this "labeling" step.

Greetings,

Mark

Advise to allow wss://ws.gleap.io in content-security-policy with version 12

Starting from v12, Gleap use websockets.
I think the changelog should mention as a breaking change that wss://ws.gleap.io should be now allowed in content-security-policy, otherwise (like in our app), the sdk will break.

screenshot capturing does not record modal boxes

Hi there!

First, congrats to the very nice product, we are seeing significant speed up to our bug reporting process!

One issue we recently found is that screenshots from modal boxes are not recorded correctly.
E.g. when a user tried to report the UI bug of the sign in form below, the received screenshot does no show the modal itself.

Actual Screen:

Reported Screenshot from Bug Battle:

Greetings,

Mark

Keep README + documentation up-to-date

Version: "bugbattle": "^3.3.0",

The README + documentation is not up-to-date with the actual available options in the SDK.

Example:

The README still tells you, you can use custom data using the following option:

While the actual available option is:

BugBattle.attachCustomData({
    test1: 'Battle',
    data2: 'Unicorn',
});

Adapt .gitignore

Add proper .gitignore. (e.g. .DS_Store)