Quick Start Guide

This guide will help you set up Errordeck and start monitoring your application's errors in just a few minutes.

Step 1: Create Your Account

1. Go to Errordeck Dashboard
2. Click on "Sign Up" or "Sign in"
3. Complete the registration process using your email

Step 2: Create Your First Project

1. From your dashboard, click "New Project"
2. Enter your project details:
   • Project name
   • Environment (e.g., Production, Staging)
   • Platform/Framework

Step 3: Install the SDK

Choose your platform and follow the installation instructions:

Ruby (Native SDK)

# Using bundler
bundle add errordeck-ruby

Add to your Ruby application:

require 'errordeck'

Errordeck.configure do |config|
  config.dsn = 'your-project-dsn'
  config.environment = 'production'
end

For Rails applications, create config/initializers/errordeck.rb:

Errordeck.configure do |config|
  config.dsn = 'your-project-dsn'
  config.environment = Rails.env
end

JavaScript/Node.js

# Using npm
npm install @sentry/node

# Using yarn
yarn add @sentry/node

Initialize in your application:

import * as Sentry from "@sentry/node";

Sentry.init({
  dsn: "your-project-dsn",
  environment: "production",
  integrations: [
    // Add integrations here
  ],
});

React

# Using npm
npm install @sentry/react

# Using yarn
yarn add @sentry/react

Wrap your application:

import * as Sentry from "@sentry/react";

Sentry.init({
  dsn: "your-project-dsn",
  environment: "production",
  integrations: [
    new Sentry.BrowserTracing(),
    new Sentry.Replay(),
  ],
});

function App() {
  return (
    <Sentry.ErrorBoundary fallback={<ErrorPage />}>
      {/* Your app components */}
    </Sentry.ErrorBoundary>
  );
}

Next.js

# Using npm
npm install @sentry/nextjs

# Using yarn
yarn add @sentry/nextjs

Run the Sentry wizard:

npx @sentry/wizard -i nextjs

This will create the necessary Sentry configuration files. Update them with your DSN.

Step 4: Test the Integration

Add a test error to verify the setup:

For Ruby:

begin
  # Trigger a test error
  raise StandardError, 'Test Error - Errordeck Integration'
rescue => error
  Errordeck.capture_exception(error)
end

For other platforms:

try {
  // Trigger a test error
  throw new Error('Test Error - Errordeck Integration');
} catch (error) {
  Sentry.captureException(error);
}

Step 5: Configure Error Notifications

1. Go to Project Settings > Notifications
2. Set up notification channels:
   • Email alerts
   • Slack integration
   • Discord webhooks
   • Custom webhooks

Need Help?

If you run into any issues during setup:

3. Contact our Support Team

Remember to replace your-project-dsn with the actual DSN from your project settings. You can find this in your project's configuration page.