Conga Sign APIs Developer Sandbox

A development sandbox application built with Svelte (frontend) and Express (backend) for testing and learning about Conga Sign's eSignature APIs.

Features

• Configure Conga Sign API credentials and environments
• View, resend, and cancel eSignature transactions
• Simulate the recipient's signing experience
• Test-driven development approach with unit and e2e tests

Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm (v7 or higher)
• Conga Sign API credentials (client ID, client secret, and platform email)

Installation

1. Clone the repository
2. Install dependencies:

npm install

Configuration

1. Start the application (see Development section below)
2. Navigate to the Config page
3. Enter your Conga Sign API credentials:
   • Region: Select your Conga Sign region (US, EU, or AU)
   • Client ID: Your Conga Sign client ID
   • Client Secret: Your Conga Sign client secret
   • Platform Email: The email address of your Conga Sign user
   • Callback URL (optional): URL for webhook notifications
4. Click "Save Configuration" to save your credentials
5. Click "Generate Token" to authenticate with the Conga Sign API
6. Click "Test Config" to verify your credentials work correctly

Development

Start both the frontend and backend development servers:

npm run dev

This will start:

• Svelte frontend on http://localhost:5173
• Express backend on http://localhost:3000

The frontend is configured to proxy API requests to the backend automatically.

Local Development with External APIs

When developing locally, you might need a tunnel to the internet for API callbacks:

# Install ngrok
npm install -g ngrok

# Expose your backend to the internet
ngrok http 3000
# Or with a reserved domain:
ngrok http --domain your-domain.ngrok-free.app 3000

Use the provided HTTPS URL as your callback URL in the Config page.

Note: This is only needed for local development. In cloud environments like Replit, the application will be publicly accessible without tunneling.

Features

• Configuration Page: Setup and manage your Conga Sign API credentials
• Admin Dashboard: View, resend, and cancel eSignature transactions
• End User Simulator: Generate signing URLs and simulate the recipient experience

Testing

Run unit tests:

npm test

Run end-to-end tests:

npm run test:e2e

Testing Guidelines

This project follows specific testing principles:

1. Focus on Happy Path: Tests should only verify correct behavior under normal, expected conditions. Do not write tests for error handling or edge cases.

2. Avoid Granular Tests: Tests should focus on meaningful functionality rather than implementation details. Keep tests simple and maintainable.

3. All Tests Must Pass: Before committing any code, ensure that all tests pass successfully. Run tests frequently during development.

Building for Production

Build the application for production deployment:

npm run build:all

Start the production server:

npm start

Project Structure

├── docs/              # Documentation files
├── public/            # Static assets
├── src/
│   ├── backend/       # Express backend
│   │   ├── routes/    # API routes
│   │   └── services/  # Business logic and data access
│   └── frontend/      # Svelte frontend
│       ├── components/ # Reusable UI components
│       ├── lib/       # Frontend utilities
│       └── pages/     # Page components
└── tests/             # Test files
    ├── unit/          # Unit tests
    └── e2e/           # End-to-end tests

Documentation

See the docs folder for more detailed documentation:

• Start Here - Introduction and navigation
• Development Guide - Comprehensive blueprint
• API Reference - Documentation of the Express API endpoints

Utility Features

Reset Application

To quickly reset the application to a clean state:

1. Navigate to the System Utilities page by clicking "System" in the navigation bar
2. Choose whether to keep your environment settings
3. Click "Reset Application Data"

This will clear all configuration and transaction data, allowing you to start fresh.

Sample Data Generation

To quickly populate the application with sample transactions for testing:

1. Navigate to the System Utilities page
2. Click "Create Sample Data"

This will create several sample transactions with different statuses and configurations for demonstration purposes.

License

This project is proprietary and not for public distribution.