Skip to content

stillrivercode/customer-intelligence

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Customer Intelligence Dashboard

A comprehensive B2B SaaS customer health monitoring dashboard that demonstrates Document Driven Development (DDD) methodology through hands-on workshops. Built with modern React, TypeScript, and real-world API integrations.

🎯 Workshop Overview

This project serves as the primary example for Stillriver Software Solutions' Document Driven Development Workshop Series, delivered in partnership with ThisDot. Participants build a production-ready customer intelligence platform while learning to leverage AI for specification-driven code generation.

Key Learning Objectives

  • βœ… Master DDD methodology - Specification-first development approach
  • βœ… AI-assisted coding - Generate production code from detailed specifications
  • βœ… Real-world integration - Connect to external APIs with proper error handling
  • βœ… Business intelligence - Build meaningful customer health scoring algorithms
  • βœ… Modern React patterns - Hooks, context, performance optimization
  • βœ… Production readiness - Testing, security, deployment considerations

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • Basic React/TypeScript knowledge

Installation

# Clone the repository
git clone https://github.com/stillrivercode/customer-intelligence.git
cd customer-intelligence

# Run automated setup (installs dependencies, sets up workflows)
./install.sh

# No environment setup needed for basic functionality

# Start development server
npm run dev

No API Key Required

The Stillriver API is a public proxy service - no API key or registration needed. Just start the development server and begin building!

πŸ“š Workshop Structure

Progressive Learning Path

Phase Duration Focus Key Skills
Phase 1 30 min Basic Dashboard React components, mock data, localStorage
Phase 2 45 min API Integration Rate limiting, error handling, real data
Phase 3 45 min Intelligence Layer Health scoring, sentiment analysis, business logic
Phase 4 60 min Advanced Features Real-time updates, alerts, performance optimization

Workshop Materials

πŸ—οΈ Architecture & Features

Customer Intelligence Platform

Core Widgets:

  • Health Score Calculator - Multi-factor customer health assessment
  • Market Intelligence Feed - Automated news monitoring with sentiment analysis
  • Geographic Insights - Location-based business intelligence
  • Engagement Optimizer - Communication timing and channel recommendations

Technical Stack:

  • Frontend: React 18, TypeScript, Tailwind CSS
  • Build Tool: Vite 6 with modern ES modules
  • API Integration: Stillriver API (proxy for domain, news, geographic data)
  • State Management: React Context with localStorage persistence
  • Testing: Vitest with Happy DOM
  • Code Quality: ESLint 9 (flat config), Prettier

Business Value Demonstration

Measurable Outcomes:

  • πŸ“Š Customer Health Scoring - Automated risk assessment
  • πŸ“° Market Intelligence - Real-time company news analysis
  • 🌍 Geographic Context - Location-based business insights
  • πŸ“ž Engagement Optimization - Data-driven communication strategies
  • ⚑ Performance - Sub-2-second load times with intelligent caching

πŸŽ“ Document Driven Development (DDD)

Methodology Overview

DDD transforms traditional development by putting specifications first:

  1. Write detailed specifications for each component
  2. Generate code using AI from these specifications
  3. Iterate and refine through testing and validation
  4. Scale efficiently with consistent patterns

Workshop Benefits

For Developers:

  • Learn cutting-edge AI-assisted development
  • Master specification writing for better code quality
  • Experience modern React and TypeScript patterns
  • Build portfolio-worthy customer intelligence platform

For Organizations:

  • Evaluate DDD methodology for team adoption
  • Assess AI-powered development productivity gains
  • Understand customer success platform architecture
  • Pilot advanced development workflows

πŸ› οΈ Development Commands

# Development
npm run dev              # Start development server
npm run build            # Production build
npm run preview          # Preview production build

# Code Quality
npm run lint             # ESLint checking
npm run lint:fix         # Auto-fix linting issues
npm run format           # Prettier formatting
npm run type-check       # TypeScript validation

# Testing
npm run test             # Run tests with Vitest
npm run test:ui          # Visual test interface
npm run test:coverage    # Coverage report

# Analysis
npm run analyze          # Bundle size analysis

βš™οΈ GitHub Configuration

Required Repository Secrets

To enable AI-powered workflows (code reviews, etc.), configure these secrets in your repository settings:

Optional Repository Variables

  • AI_MODEL - The AI model to use for reviews (defaults to anthropic/claude-3.5-sonnet)

Setting Up Secrets and Variables

  1. Go to your repository's Settings β†’ Secrets and variables β†’ Actions
  2. Add OPENROUTER_API_KEY as a Repository Secret
  3. (Optional) Add AI_MODEL as a Repository Variable

Manual Review Triggers

The AI PR Review workflow can be triggered manually:

  • Add label: ai-review-needed to any PR
  • Comment: /review on any PR

πŸ“‹ Component Specifications

Detailed Technical Specs

Each specification includes:

  • Functional requirements and acceptance criteria
  • Data sources and processing logic
  • Visual design and user experience
  • Performance requirements and optimization
  • Testing strategies and validation

πŸ”§ API Integration

Stillriver API Endpoints Used

Endpoint Purpose Dashboard Feature
/whois Domain registration info Company stability metrics
/urllookup Website availability Uptime monitoring
/news Company news Market intelligence
/city Demographics Location insights
/timezone Time zone data Communication optimization
/holidays Holiday calendar Engagement planning

Features:

  • Rate limiting (varies by endpoint: 100-1000 req/hour)
  • Intelligent caching with dynamic TTL
  • Built-in proxy layer for reliability
  • Graceful error handling
  • Offline mode support

🎯 Success Metrics

Workshop Completion Targets

  • 90% complete Phase 1 & 2 (basic functionality)
  • 80% complete Phase 3 (intelligence features)
  • 60% attempt Phase 4 (advanced features)
  • 4.5/5 average satisfaction rating

Technical Achievements

  • < 2 seconds initial dashboard load time
  • > 90% API integration success rate
  • 100% health score calculation accuracy
  • > 95% performance targets met

πŸ”„ Recent Changes

v2.0 Migration Note

  • CLI Tools Removed: This version focuses on the React application workshop experience
  • API Simplified: Switched to Stillriver API - no API keys needed for workshop simplicity
  • Setup Streamlined: Run ./install.sh and npm run dev to get started immediately

For workshop participants: The setup is now even easier with zero configuration required!

πŸ“ˆ Business Impact

ROI Demonstration

Time Savings:

  • Customer health reviews: 3 hours β†’ 15 minutes
  • Market research: 2 hours β†’ automated
  • Communication planning: 30 minutes β†’ real-time

Risk Reduction:

  • 20% improvement in churn prediction
  • Early warning system for at-risk accounts
  • Automated competitive intelligence

πŸ†˜ Support & Resources

Workshop Support

  • Real-time Help: Instructor guidance throughout
  • Comprehensive Docs: Step-by-step guides for each phase
  • Code Examples: Working solutions provided
  • Troubleshooting: Common issues documented with solutions

Additional Resources

πŸ“„ License

MIT License - Free for educational and commercial use.

🀝 About Stillriver

This workshop is part of the Document Driven Development Series by Stillriver Software Solutions LLC, delivered in partnership with ThisDot. We specialize in AI-powered development methodologies that accelerate software delivery through specification-driven code generation.

Ready to experience the future of development?

git clone https://github.com/stillrivercode/customer-intelligence.git
cd customer-intelligence
./install.sh
npm run dev

πŸŽ“ Start Your DDD Journey - Begin with the Workshop Guide

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •