@shakebugs/browser
v3.3.3
Published
Browser SDK for Shake
Maintainers
decode-hqReadme
Shake Web SDK
Browser plugin for bug reporting.
Features
| Feature | Available | | :-------------: | :-------: | | Bug reporting | ✅ | | Crash reporting | ❌ | | Users | ✅ |
How to use
NPM
1. Install Shake
Execute the npm install command in your terminal:
npm install @shakebugs/browser2. Start Shake
Once installed, you can start using the library by calling Shake.start() at the top level of your app
// Import the library if using ES6 modules
import Shake from '@shakebugs/browser';
Shake.start('app-api-key');Replace app-api-key with the actual value you have in your app settings on dashboard.
Optionally, pass your app version as the second argument. Web apps don't have a built-in versioning system, so Shake can't detect it automatically — it defaults to "1.0.0" if you don't pass one.
Shake.start('app-api-key', '1.0.0');CDN
Alternatively, library can be added to your project through CDN. Bundle is delivered through JSDelivr CDN.
1. Install Shake
Add the following script to your code:
<script type="module">
import Shake from 'https://cdn.jsdelivr.net/npm/@shakebugs/browser@latest/+esm';
window.Shake = Shake;
</script>2. Start Shake
Once installed, you can start using the library by calling Shake.start() at the top level of your app
<body>
<script>
window.Shake.start('app-api-key');
</script>
</body>Replace app-api-key with the actual value you have in your app settings on dashboard.
Optionally, pass your app version as the second argument. Web apps don't have a built-in versioning system, so Shake can't detect it automatically — it defaults to "1.0.0" if you don't pass one.
<body>
<script>
window.Shake.start('app-api-key', '1.0.0');
</script>
</body>