Skip to content

francknouama/go-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

327 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

go-starter

Go Report Card Go Reference License: MIT Release

The most comprehensive Go project generator featuring a professional Web UI interface and powerful CLI with 12 production-ready blueprints. โœ… PHASE 4 WEB UI COMPLETE! The first Go generator with real-time visual preview, dual interface system, and 30-second project generation. Generate production-ready Go projects that compile immediately and follow enterprise best practices.

Professional Web UI Interface Professional React interface with real-time preview and visual blueprint selection

โšก Choose Your Interface - Dual Excellence

๐Ÿ–ฅ๏ธ Professional Web UI (NEW - Recommended)

# Launch professional Web UI (Best for all users)
go-starter web

# Opens browser at http://localhost:3000 with:
# โœจ Visual blueprint gallery with 12 production-ready templates
# ๐Ÿ”„ Real-time project generation with WebSocket updates
# ๐Ÿ“ฑ Responsive design for desktop, tablet, and mobile
# ๐ŸŽฏ Interactive configuration with smart validation
# ๐Ÿ‘๏ธ Live preview of project structure and files
# โ™ฟ WCAG AA compliant with full keyboard navigation

Blueprint Gallery Interactive blueprint gallery with rich descriptions and live preview

Real-time Preview WebSocket-powered real-time preview with syntax highlighting

๐Ÿ’ป CLI Interactive Mode (Power Users)

# Install once
go install github.com/francknouama/go-starter@latest

# Start CLI interactive guided project creation
go-starter new

# The CLI interactive wizard will guide you through:
# โœ… Project name (with random generator option)
# โœ… Blueprint selection (with descriptions)
# โœ… Complexity level (Simple โ†’ Expert)
# โœ… Framework choice (context-aware options)
# โœ… Logger selection (4 options)
# โœ… Additional features (database, auth, etc.)

CLI Interactive Mode CLI progressive disclosure showing basic options for beginners

๐Ÿš€ Direct Mode (Non-Interactive)

# Skip interactive prompts with flags
go-starter new my-api --type web-api --logger zap

cd my-api
make run    # Server running on :8080
make test   # All tests pass โœ…
make build  # Production binary ready ๐Ÿš€

๐ŸŽฏ Progressive Disclosure - Start Simple, Scale Smart

# Web UI automatically adapts to your experience
go-starter web              # Professional interface for all users

# CLI mode adapts to your experience level
go-starter new              # Basic options (beginner-friendly)
go-starter new --advanced   # All options (power users)

# Direct mode with complexity control
go-starter new my-tool --type cli --complexity simple    # 8 files
go-starter new my-tool --type cli --complexity standard  # 29 files

That's it. No configuration files. No dependency hunting. No project structure decisions. Just working, production-ready code that scales with your needs.

๐ŸŽฏ What You Get - Professional Dual Interface

๐Ÿ–ฅ๏ธ Industry-First Web UI

โœจ Modern React Interface - Professional design with TypeScript and Tailwind CSS
๐Ÿ”„ Real-time Preview - WebSocket-powered live generation with syntax highlighting
๐Ÿ“ฑ Responsive Design - Desktop, tablet, and mobile optimized
โ™ฟ Accessibility - WCAG AA compliant with keyboard navigation
๐ŸŽฏ Smart Validation - Form validation with helpful error messages

Mobile Responsive Mobile-optimized interface with touch-friendly interactions

๐Ÿ’ป Powerful CLI

๐ŸŽ›๏ธ Progressive Disclosure - Smart help adapting to experience level
โšก Fast Generation - 30-second project creation with zero setup
๐Ÿ”ง Interactive Prompts - Context-aware options with intelligent defaults

๐Ÿš€ Enterprise Ready

โœ… Compiles immediately - Zero setup, zero errors, zero configuration
โœ… Production-ready - Industry best practices built-in
โœ… Complete tests - Unit, integration, benchmarks included
โœ… Docker ready - Dockerfile and docker-compose configured
โœ… CI/CD included - GitHub Actions ready to deploy
โœ… Full documentation - README, API docs, examples generated

๐ŸŽ‰ Phase 4 Achievement - Industry-First Web UI!

HISTORIC MILESTONE: First Go project generator with professional Web UI and real-time preview - setting the new industry standard!

Configuration Panel Smart configuration panel with contextual help and validation

โœจ Revolutionary Web UI Features

  • ๐ŸŽจ Visual Blueprint Gallery: Interactive showcase of 12 production-ready templates with rich comparisons
  • ๐Ÿ”„ Real-time Preview: Live project structure and file content updates via WebSocket
  • ๐Ÿ“‹ Smart Configuration: Form-based setup with intelligent validation and contextual hints
  • ๐Ÿ“ฑ Responsive Excellence: Professional design optimized for desktop, tablet, and mobile
  • ๐Ÿ”— WebSocket Integration: Live generation progress with detailed real-time feedback
  • โ™ฟ Universal Accessibility: WCAG AA compliant with full keyboard navigation support

File Explorer Live file explorer showing generated project structure with syntax highlighting

โœ… 12 Production-Ready Blueprints ๐ŸŽ‰ 100% COVERAGE + WEB UI INTEGRATION!

Blueprint Showcase Web API blueprint configuration with real-time preview

Blueprint Files Use Case Web UI Enhanced
CLI-Simple 8 Learning & Utilities โœ… Visual Config
CLI-Standard 29 Production CLIs โœ… Preview Structure
Library-Standard 10 Reusable Packages โœ… API Documentation
Web-API-Standard 25 REST APIs & CRUD โœ… Live Testing
Web-API-Clean 40 Enterprise APIs โœ… Architecture View
Web-API-Echo 25 High Performance โœ… Middleware Config
Web-API-Fiber 25 Ultra-fast APIs โœ… Performance Metrics
Lambda-Standard 15 Serverless Functions โœ… AWS Integration
Lambda-Proxy 20 API Gateway โœ… Route Preview
gRPC-Gateway 45 Dual APIs โœ… Protocol View
Monolith 72 Web Applications โœ… Full Stack View
Microservice 47 Enterprise Services โœ… Service Mesh

Phase 4 Achievement: Complete Web UI integration with all 12 production-ready blueprints, featuring real-time preview and professional interface design.

Web UI System Achievements:

  • Professional Interface: React 19.1.0 + TypeScript + Tailwind CSS
  • Real-time Updates: WebSocket integration with live preview
  • 80%+ Test Coverage: Jest + Playwright comprehensive testing
  • Cross-Platform Web: Desktop, tablet, and mobile compatibility
  • Accessibility: WCAG AA compliance with keyboard navigation

ATDD Framework (Complete):

  • Sprig Template Functions: Fixed 296+ template errors
  • Cross-Platform Testing: Windows, macOS, Linux validated
  • Progressive Disclosure: 66.7% file reduction (CLI-Simple vs CLI-Standard)
  • Logger Integration: All 4 logger types tested and working

๐Ÿš€ Blueprint Production Status - PHASE 4 WEB UI COMPLETE!

Historic Achievement: 12 production-ready blueprints with Professional Web UI โœ… Complete dual-interface ecosystem ready for immediate production use

โœ… All Blueprints Production-Ready (Phase 3B Complete)

Complete ATDD validation confirms all blueprints are production-ready:

Blueprint Type Files Status Key Features + Web UI
CLI-Simple CLI Tool 8 โœ… PRODUCTION + WEB Minimal structure, perfect for learning
CLI-Standard CLI Tool 29 โœ… PRODUCTION + WEB Cobra framework, production-ready
Library-Standard Go Package 10 โœ… PRODUCTION + WEB Clean API, examples, documentation
Web-API-Standard REST API 25 โœ… PRODUCTION + WEB Complete CRUD, middleware, testing
Web-API-Clean Clean Architecture 40 โœ… PRODUCTION + WEB Enterprise patterns, Clean Architecture
Web-API-Echo Echo Framework 25 โœ… PRODUCTION + WEB High-performance Echo middleware
Web-API-Fiber Fiber Framework 25 โœ… PRODUCTION + WEB Ultra-fast Fiber performance
Lambda-Standard Serverless 15 โœ… PRODUCTION + WEB AWS SDK v2, CloudWatch, X-Ray
Lambda-Proxy API Gateway 20 โœ… PRODUCTION + WEB HTTP routing, serverless integration
gRPC-Gateway Microservice 45 โœ… PRODUCTION + WEB Dual HTTP/gRPC APIs, enhanced interceptors
Monolith Web Application 72 โœ… PRODUCTION + WEB Background jobs, multi-layer caching, monitoring
Microservice gRPC Service 47 โœ… PRODUCTION + WEB OpenTelemetry, rate limiting, resilience patterns

๐ŸŽ‰ Interactive CLI Features

Powerful CLI features transforming how developers create Go projects:

๐Ÿš€ Core CLI Innovations

  • ๐ŸŽจ Progressive Disclosure: Smart help system that adapts to experience level
  • ๐Ÿ”„ Context-Aware Options: Intelligent prompts based on previous selections
  • ๐Ÿ“ฑ Cross-Platform Support: Works seamlessly on Windows, macOS, and Linux
  • โš™๏ธ Smart Defaults: Automatic framework and logger selection for common patterns
  • ๐Ÿ” Validation & Help: Real-time validation with helpful error messages

๐Ÿ“Š CLI Capabilities

  • Project Templates: 12 production-ready blueprints for every use case
  • Configuration Impact Preview: See how choices affect generated code
  • Performance Metrics: Real-time generation speed and project analysis
  • Comparison Tools: Side-by-side blueprint feature comparison

Advanced Configuration Advanced configuration mode showing expert-level options with contextual help

๐Ÿš€ Phase 3B Production Enhancements (Complete)

Enterprise-grade features included in all applicable blueprints:

  • ๐Ÿ” Enhanced Observability: OpenTelemetry tracing, Prometheus metrics, health checks
  • ๐Ÿ›ก๏ธ Advanced Security: Input validation, rate limiting, security headers, CORS
  • ๐Ÿ”„ Resilience Patterns: Circuit breakers, retry logic, graceful error handling
  • โšก Performance Optimization: Multi-layer caching, connection pooling, resource management
  • ๐Ÿ”ง Background Processing: Comprehensive job manager with queuing and monitoring
  • ๐ŸŒ Enterprise Middleware: Enhanced interceptors with monitoring and security

๐ŸŽ›๏ธ Simplified Logger Architecture โœจ

Major Enhancement: 60-90% code reduction while maintaining all logger functionality

Choose your logging strategy with simplified implementation:

go-starter new api --logger zap        # Zero allocations โšก (91% less code)
go-starter new app --logger slog       # Standard library ๐Ÿ“š (default)
go-starter new service --logger zerolog # JSON optimized โ˜๏ธ (72% less code)
go-starter new tool --logger logrus    # Feature-rich ๐Ÿ”ง (simplified interface)

Logger Complexity Reduction:

  • CLI Standard: 1,051 โ†’ 98 lines (91% reduction)
  • Web API Standard: 398 โ†’ 110 lines (72% reduction)
  • Single Interface: Consistent API across all loggers
  • Conditional Dependencies: Only selected logger included

Progressive Complexity Examples:

# Start simple, grow as needed - VALIDATED file counts
go-starter new my-tool --type cli --complexity simple   # 10 files โœ…
go-starter new my-tool --type cli --complexity standard # 28 files โœ…
go-starter new my-api --type web-api                    # 44 files โœ…
go-starter new my-lambda --type lambda                  # 17 files โœ…
go-starter new my-lib --type library                    # 19 files โœ…
go-starter new my-clean --type web-api --architecture clean # 69 files โœ…
go-starter new my-gateway --type grpc-gateway           # 45 files โœ…

Switch anytime without changing application code.

๐Ÿ“ˆ Transform Your Go Development Experience

๐Ÿ”„ go-starter vs Traditional Generators

Traditional Generators go-starter CLI
๐Ÿ• 2-4 hours setup โšก 30 seconds
๐Ÿ› Configuration bugs โœ… Smart prompts
๐Ÿ“š Research best practices ๐Ÿ† Context help
โš ๏ธ Missing tests/Docker/CI ๐Ÿš€ Everything included
๐Ÿ‘“ Text-only interface ๐Ÿ’ป Progressive disclosure
๐Ÿค” Unclear choices ๐Ÿ“‹ Intelligent defaults
๐Ÿ”„ Manual restart needed โšก Instant generation
๐Ÿ“ฑ Desktop only ๐Ÿ’ป Cross-platform

๐Ÿƒโ€โ™‚๏ธ Quick Start

Basic Mode (Beginner-Friendly)

# 1. Install
go install github.com/francknouama/go-starter@latest

# 2. Generate with guided prompts (shows 14 essential options)
go-starter new my-project

# 3. Ship
cd my-project && make run

Advanced Mode (Power Users)

# See all 18+ options for complex projects
go-starter new --advanced --help

# Generate enterprise patterns directly
go-starter new enterprise-api --type web-api --architecture hexagonal --advanced

# Create workspace for monorepos
go-starter new my-workspace --type workspace

Alternative installation: Download binaries โ€ข All methods

๐Ÿ“š Documentation

๐ŸŽฏ Quick Start Paths (Choose Your Journey)

๐Ÿ’ป CLI Path

๐Ÿค Contributors & Community

๐Ÿ“š Comprehensive Documentation Hub

๐ŸŽฏ Documentation Hub - Visual guides with progressive disclosure and persona-based navigation

๐Ÿ–ฅ๏ธ Web UI Documentation (NEW)

๐Ÿ—๏ธ Blueprint Resources (100% Production Coverage + Web UI)

๐Ÿ”ง Technical Resources

๐Ÿ›ฃ๏ธ Current Status & Roadmap

Current (v4.0+): โœ… Professional Web UI with real-time preview, โœ… 12 production-ready blueprints (HISTORIC 100% COVERAGE!), โœ… Dual interface system, progressive disclosure, simplified logger architecture, enterprise observability, advanced resilience patterns, comprehensive ATDD testing framework

โœ… Phase 2.1 Core Infrastructure - ๐Ÿš€ COMPLETED

  • โœ… Progressive Disclosure System - Smart help with basic/advanced modes
  • โœ… ATDD Testing Framework - Comprehensive blueprint validation
  • โœ… Template Function Fixes - Resolved 296+ Sprig template errors
  • โœ… CLI Two-Tier Approach - Simple (10 files) vs Standard (28 files)
  • โœ… Simplified Logger Architecture - 60-90% code reduction
  • โœ… Production Blueprint Validation - 7 blueprints fully verified
  • โœ… Cross-Platform Testing - Windows, macOS, Linux compatibility

โœ… Phase 2.2 - Enhancement Sprint (COMPLETED)

  • โœ… Web-API-Clean - Now production-ready with Clean Architecture patterns
  • โœ… gRPC-Gateway - Now production-ready with dual HTTP/gRPC support โœ… MILESTONE ACHIEVED
  • โœ… Blueprint Metrics - File count accuracy validated and updated
  • โœ… Hook-Enhanced Agent Workflow - Multi-specialist coordination proved highly effective

๐Ÿ”„ Phase 3 - Major Blueprint Development

  • ๐Ÿ”„ Event-Driven Architecture - 58 missing files implementation
  • ๐Ÿ—๏ธ Microservice-Standard - Service mesh and observability patterns
  • ๐Ÿข Monolith - Modular architecture with background job processing
  • ๐Ÿ”ง Go Workspace - Multi-module monorepo tooling

โœ… Phase 4 - WEB UI COMPLETE!

  • โœ… Professional Web UI - React + TypeScript + Tailwind CSS โœ… ACHIEVED
  • โœ… Real-time Preview - WebSocket integration with live updates โœ… ACHIEVED
  • โœ… Mobile Responsive - Desktop, tablet, mobile optimization โœ… ACHIEVED
  • โœ… Accessibility - WCAG AA compliance with keyboard navigation โœ… ACHIEVED

๐Ÿ”ฎ Phase 5 - Future Enhancements

  • ๐Ÿ” Advanced Analytics - Usage metrics, performance insights, project analytics
  • ๐Ÿช Blueprint Marketplace - Community templates, sharing, and collaboration
  • โ˜๏ธ Cloud Integration - Direct deployment to AWS, GCP, Azure
  • ๐Ÿค– AI-Powered Suggestions - Smart recommendations based on project patterns

โค๏ธ Community & Support

๐Ÿ†˜ Getting Help

๐Ÿค Contributing

๐ŸŒŸ Community Resources

๐Ÿ“„ License

MIT License - see LICENSE file for details.


Ready to experience the most comprehensive Go generator?

# Beginner? Start here
go install github.com/francknouama/go-starter@latest
go-starter new my-first-project

# Power user? Go advanced
go-starter new enterprise-system --type microservice --architecture hexagonal --advanced

๐Ÿš€ From simple scripts to enterprise architectures - go-starter scales with you.

๐Ÿš€ Roadmap - Go Workspace Migration

Current Focus: Modular Architecture

We're migrating go-starter to a Go workspace structure to improve modularity and enable independent development of core, CLI, and Web UI components.

๐Ÿ“‹ Track Progress: GitHub Project #10

Migration Phases

  • Phase 1: Architecture Analysis & Planning (#227-229)
  • Phase 2: Core Module Extraction (#230-231)
  • Phase 3: CLI Module Separation (#232-233)
  • Phase 4: Web Module Independence (#234)
  • Phase 5: Workspace Configuration (#235, #240)
  • Phase 6: Validation & Documentation (#236-239)

Timeline: Q1 2025 (10-15 days estimated)

Benefits of Workspace Structure

  • Better Modularity - Independent versioning and development
  • Cleaner Dependencies - Clear module boundaries
  • Improved Testing - Module-level and integration tests
  • Flexible Deployment - Use modules independently or together
  • Backward Compatibility - Smooth migration for existing users

โญ Star us on GitHub โ€ข ๐Ÿ› Report Issues โ€ข ๐Ÿ’ฌ Join Discussions

About

Stop fighting boilerplate. Generate complete, production-ready Go projects that compile immediately and follow best practices.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors