Installation

This guide will walk you through the process of installing Bugster SDK in your web application project. Follow these steps to get Bugster SDK up and running quickly.

​

Step 1: Install the Bugster SDK Package

First, you need to install the Bugster SDK package using npm (Node Package Manager). Open your terminal, navigate to your project directory, and run one of the following commands:

This command will download and install the latest version of Bugster SDK and add it to your project’s dependencies.

​

Step 2: Import Bugster SDK

After installing the package, you need to import Bugster SDK into your application. Add the following import statement at the top of your main JavaScript or TypeScript file:

​

Step 3: Initialize Bugster SDK

Once imported, you need to initialize Bugster SDK with your project configuration. Add the following code to your main file, typically right after your imports:

Replace 'YOUR_BUGSTER_API_KEY' with the actual api key from your Bugster dashboard.

​

Step 4: Verify Installation

To verify that Bugster SDK is installed and initialized correctly, you can add a simple log statement:

If you see the success message in your browser’s console when you run your application, Bugster SDK is installed and initialized correctly.

​

Framework-Specific Installation

For specific Framework installation visit Framework Guide for installing the snippet with popular client-side langauges.

​

Advanced Configuration

Bugster SDK offers various configuration options to customize its behavior. Here are some common options:

BugsterTracker.init({
  apiKey: 'YOUR_BUGSTER_API_KEY',
  captureNetworkRequests: true,
  ignoredUrls: ['https://example.com/api/ignored'],
  maxEventsPerMinute: 100,
  // Other configuration options
});

For a full list of configuration options, refer to our API Documentation.

​

Troubleshooting

If you encounter any issues during installation, try the following:

1. Ensure you’re using a compatible Node.js version (19.x or later).
2. Clear your npm cache: npm cache clean --force
3. Delete your node_modules folder and package-lock.json file, then run npm install again.

If problems persist, check our Troubleshooting Guide or contact our support team.

​

Next Steps

Now that you have Bugster SDK installed and initialized, you’re ready to start viewing user stories and generating tests. Check out our Quick Start Guide for next steps!