instantly-local-dev-loop

Configure Instantly local development with hot reload and testing.Use when setting up a development environment, configuring test workflows,or establishing a fast iteration cycle with Instantly.Trigger with phrases like "instantly dev setup", "instantly local development","instantly dev environment", "develop with instantly".

⭐939stars🔀114forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

The Instantly Local Dev Loop skill automates the setup of a high-performance TypeScript development environment specifically for Instantly SDK integrations. It streamlines the creation of project structures, configures hot-reloading for real-time feedback, and establishes a robust testing framework using Vitest, enabling developers to move from configuration to coding in seconds.

Use Cases

  • Rapid Project Scaffolding: Automatically generate a standardized directory structure, including client wrappers and configuration files, for new Instantly-based applications.
  • Fast Iteration Cycles: Implement a 'save-to-run' workflow using hot-reload (tsx watch) to instantly validate code changes without manual restarts.
  • Automated Testing Setup: Configure a complete Vitest suite with pre-written test examples and mocking patterns to ensure reliable integration with the Instantly API.
  • Environment Standardization: Streamline team onboarding by providing reproducible setup steps for environment variables, dependencies, and local development scripts.
nameinstantly-local-dev-loop
description|
allowed-toolsRead, Write, Edit, Bash(npm:*), Bash(pnpm:*), Grep
version1.0.0
licenseMIT
authorJeremy Longshore <jeremy@intentsolutions.io>

Instantly Local Dev Loop

Overview

Set up a fast, reproducible local development workflow for Instantly.

Prerequisites

  • Completed instantly-install-auth setup
  • Node.js 18+ with npm/pnpm
  • Code editor with TypeScript support
  • Git for version control

Instructions

Step 1: Create Project Structure

my-instantly-project/
├── src/
│   ├── instantly/
│   │   ├── client.ts       # Instantly client wrapper
│   │   ├── config.ts       # Configuration management
│   │   └── utils.ts        # Helper functions
│   └── index.ts
├── tests/
│   └── instantly.test.ts
├── .env.local              # Local secrets (git-ignored)
├── .env.example            # Template for team
└── package.json

Step 2: Configure Environment

# Copy environment template
cp .env.example .env.local

# Install dependencies
npm install

# Start development server
npm run dev

Step 3: Setup Hot Reload

{
  "scripts": {
    "dev": "tsx watch src/index.ts",
    "test": "vitest",
    "test:watch": "vitest --watch"
  }
}

Step 4: Configure Testing

import { describe, it, expect, vi } from 'vitest';
import { InstantlyClient } from '../src/instantly/client';

describe('Instantly Client', () => {
  it('should initialize with API key', () => {
    const client = new InstantlyClient({ apiKey: 'test-key' });
    expect(client).toBeDefined();
  });
});

Output

  • Working development environment with hot reload
  • Configured test suite with mocking
  • Environment variable management
  • Fast iteration cycle for Instantly development

Error Handling

Error Cause Solution
Module not found Missing dependency Run npm install
Port in use Another process Kill process or change port
Env not loaded Missing .env.local Copy from .env.example
Test timeout Slow network Increase test timeout

Examples

Mock Instantly Responses

vi.mock('@instantly/sdk', () => ({
  InstantlyClient: vi.fn().mockImplementation(() => ({
    // Mock methods here
  })),
}));

Debug Mode

# Enable verbose logging
DEBUG=INSTANTLY=* npm run dev

Resources

Next Steps

See instantly-sdk-patterns for production-ready code patterns.