Skip to main content

Cimigo Collect Platform Documentation

Welcome to the Cimigo Collect Platform - a comprehensive, production-ready multi-tenant survey collection platform designed for scalability, reliability, and exceptional developer experience.

🎯 Choose Your Path​

The documentation is organized by role and use case. Choose the path that best fits your needs:

👨‍💻 For Platform Developers​

Building, extending, or contributing to the Cimigo Collect Platform itself?

Developer Documentation →

  • System architecture and design patterns
  • Codebase structure and conventions
  • Development environment setup
  • Contribution guidelines
  • API development and extension
  • Database schema and migrations
  • Testing strategies and CI/CD

🏢 For Tenant Organizations​

Integrating surveys into your applications or managing survey operations?

Tenant Guide →

  • Quick start integration guide
  • JavaScript SDK usage and examples
  • Survey creation and management
  • Response collection workflows
  • Webhook integration patterns
  • Theme customization and branding
  • Multi-language survey support

🚀 What is the Cimigo Collect Platform?​

The Cimigo Collect Platform is an enterprise-grade, multi-tenant survey platform that provides:

🏗️ Core Capabilities​

  • 📝 Survey Collection: Robust response collection with real-time validation
  • 🔗 Flexible Distribution: Public links, personalized URLs, and embedded widgets
  • 🌐 JavaScript SDK: Easy integration with React, Vue, Angular, and vanilla JS
  • 📊 Real-time Integration: Webhook delivery and streaming data exports
  • 🏢 Multi-tenant Architecture: Complete data isolation with role-based access
  • 🔒 Enterprise Security: JWT authentication, API keys, and audit logging
  • ⚡ High Performance: Built on FastAPI with async operations

🎨 Survey Features​

  • Multiple Question Types: Single/multiple choice, text, Likert scales, NPS, matrix, date pickers
  • Conditional Logic: Dynamic question visibility based on responses
  • Multi-language Support: Internationalization with locale-specific content
  • Custom Themes: Brand colors, logos, and styling
  • Mobile Optimization: Responsive design with accessibility support
  • Progressive Saving: Automatic draft saving to prevent data loss

🔌 Integration Options​

  • JavaScript SDK: Widget, iframe, and inline embedding modes
  • REST APIs: Direct backend integration with OpenAPI documentation
  • Webhooks: Real-time response notifications
  • Export APIs: CSV, JSON, and streaming data formats
  • Authentication: JWT tokens, API keys, and role-based permissions

🏗️ Platform Architecture​

🚦 Quick Start Options​

⚡ For Immediate Integration​

Want to embed surveys quickly?

# Install the JavaScript SDK
npm install @cimigo/collect-sdk

# Basic integration
import { CimigoCollect } from '@cimigo/collect-sdk';

const collect = new CimigoCollect({
  apiBaseUrl: 'https://collect-api.cimigo.online',
  tenantId: 'your-tenant-id'
});

// Show survey as modal
await collect.showSurvey({
  linkId: 'survey-link-id',
  mode: 'widget'
});

See Full SDK Guide → (Coming Soon)

🔧 For Platform Development​

Want to run the platform locally?

# Clone and setup
git clone https://github.com/cimigo/survey-service
cd survey-service
docker-compose up -d

# Access the platform
# API: http://localhost:8001
# Renderer: http://localhost:3000
# Docs: http://localhost:3001

See Developer Setup → (Coming Soon)

🏢 For Production Deployment​

Ready to deploy for your organization?

# Production deployment with Docker
docker-compose -f docker-compose.production.yml up -d

# Or use container orchestration
kubectl apply -f k8s/

See Deployment Guide → (Coming Soon)

📚 Popular Topics​

For Tenants​

  • JavaScript SDK Integration - Quick survey embedding (Coming Soon)
  • Survey Creation Guide - Building effective surveys (Coming Soon)
  • Response Management - Collecting and analyzing data (Coming Soon)
  • Webhook Integration - Real-time event handling (Coming Soon)
  • Theme Customization - Brand consistency (Coming Soon)

For Developers​

  • System Architecture - Technical deep dive (Coming Soon)
  • API Development - Extending the platform (Coming Soon)
  • Database Design - Schema and patterns (Coming Soon)
  • Multi-tenancy - Tenant isolation (Coming Soon)
  • Contributing - Join the development (Coming Soon)

🆘 Support & Community​

  • Tenant FAQ - Common integration questions (Coming Soon)
  • Developer FAQ - Technical issues and solutions (Coming Soon)
  • API Reference - Complete endpoint documentation (Coming Soon)
  • GitHub Issues - Bug reports and feature requests

🎉 Ready to Start?​

Choose your path and dive in:

🏢 I'm a Tenant

I want to integrate surveys into my application or manage survey operations.

Start Here →

👨‍💻 I'm a Developer

I want to contribute to, extend, or deploy the platform.

Start Here →

Welcome to the Cimigo Collect Platform! 🚀