Sigma Dashboard Setup Guide

Table of Contents

Prerequisites

Before starting, ensure you have the following installed:

Tip: You can check your Node.js version by running node --version in your terminal.

Project Setup

First, let's create our project structure. Create a new directory and save the following setup script:

#!/bin/bash
# setup.sh content here
${setup.sh content}
Project Structure:

Configuration

After running the setup script, you'll need to configure your environment:

SIGMA_API_URL=https://api.sigmacomputing.com/v2
SIGMA_CLIENT_ID=your_client_id_here
SIGMA_CLIENT_SECRET=your_client_secret_here
PORT=3000
Note: Never commit your .env file to version control. The setup script creates a .gitignore file that excludes it automatically.

Sigma API Integration

The following client handles all Sigma API interactions:

// src/api/sigma-client.js content here
${sigma-client.js content}

Dashboard Implementation

Use this template for embedding your Sigma dashboards:


${dashboard-template content}

Deployment

Follow these steps to deploy your dashboard:

  1. Set up your environment variables on your hosting platform
  2. Build your project: npm run build
  3. Start the server: npm start
Tip: Consider using a process manager like PM2 in production environments.