community-rule/README.md

Community Rule

A Next.js application for community decision-making and governance documentation.

🚀 Getting Started

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

🧪 Testing Framework

This project includes a comprehensive testing framework with multiple layers of testing:

Quick Test Commands

# Unit tests with coverage
npm test

# E2E tests
npm run e2e

# Performance tests
npm run lhci

# Storybook tests
npm run test:sb

# Performance monitoring
npm run test:performance    # Comprehensive performance testing
npm run bundle:analyze      # Bundle size analysis
npm run web-vitals:track   # Web Vitals tracking
npm run monitor:all         # All monitoring tools

Test Coverage

• ✅ 428 Unit Tests (94.88% coverage - exceeds 85% target)
• ✅ 92 E2E Tests across 4 browsers
• ✅ 23 Visual Regression Tests per browser
• ✅ Performance Budgets with Lighthouse CI
• ✅ WCAG 2.1 AA Compliance with automated testing
• ✅ Bundle Analysis with automated monitoring
• ✅ Web Vitals Tracking with real-time metrics

CI/CD Pipeline

• Gitea Actions with 7 parallel jobs
• Cross-browser testing (Chromium, Firefox, WebKit, Mobile)
• Visual regression testing
• Performance monitoring
• Code coverage reporting

📖 For detailed testing documentation, see docs/README.md

⚡ Performance Optimizations

This project includes comprehensive performance optimizations for sub-2-second load times:

Frontend Optimizations

• ✅ Code Splitting: Dynamic imports for non-critical components
• ✅ React.memo: Applied to all 30+ components to prevent unnecessary re-renders
• ✅ Image Optimization: Enhanced next/image with lazy loading and blur placeholders
• ✅ Font Optimization: Preloading and fallbacks for all fonts
• ✅ Bundle Analysis: Real-time monitoring with performance budgets
• ✅ Error Boundaries: Comprehensive error handling

Performance Monitoring

# Individual monitoring tools
npm run bundle:analyze      # Analyze bundle sizes and budgets
npm run performance:monitor # Performance metrics and Lighthouse CI
npm run web-vitals:track   # Core Web Vitals tracking

# Comprehensive testing
npm run test:performance    # All performance tests
npm run monitor:all         # All monitoring tools

Performance Targets

• Bundle Size: <250KB gzipped (currently 101KB) ✅
• Core Web Vitals: All metrics in "Good" range ✅
• Lighthouse Score: >90 on all critical pages ✅
• Load Time: <2 seconds on 3G connections ✅

📚 Storybook Development

This project includes Storybook for component development and documentation. The setup automatically detects the environment and applies the appropriate configuration.

Local Development

For local Storybook development:

npm run storybook:local
# or simply
npm run storybook

This will:

• Start Storybook at http://localhost:6006
• Use relative paths for assets (no base path)

GitHub Pages Deployment

For GitHub Pages deployment with base path:

npm run storybook:build:github

This will:

• Build Storybook with /communityrulestorybook/ base path
• Generate files ready for GitHub Pages deployment

CI/CD Integration

The CI pipeline automatically uses the GitHub Pages configuration when building Storybook.

Configuration

The Storybook configuration automatically detects the environment:

• Local development: No base path, relative assets
• CI/Production: Base path /communityrulestorybook/ for GitHub Pages

📋 Available Scripts

Development

• npm run dev - Start Next.js development server
• npm run build - Build Next.js application for production
• npm run start - Start Next.js production server

Testing

• npm test - Run unit tests with coverage
• npm run test:watch - Run tests in watch mode
• npm run test:ui - Run tests with UI
• npm run e2e - Run E2E tests
• npm run e2e:ui - Run E2E tests with UI
• npm run e2e:serve - Start dev server and run E2E tests
• npm run lhci - Run performance tests
• npm run test:sb - Run Storybook tests

Storybook

• npm run storybook:local - Start Storybook for local development
• npm run storybook:github - Start Storybook with GitHub Pages configuration
• npm run storybook:build - Build Storybook for local deployment
• npm run storybook:build:github - Build Storybook for GitHub Pages
• npm run storybook - Start Storybook with current configuration

🏗️ Project Structure

community-rule/
├── app/                          # Next.js app directory
│   ├── components/              # React components
│   ├── hooks/                   # Custom React hooks
│   ├── layout.tsx              # Root layout
│   └── page.tsx                # Homepage
├── config/                       # Project-specific configuration
│   ├── gitea-runner.yaml       # Gitea runner configuration
│   └── runner-config.yaml      # Runner configuration
├── docs/                         # Documentation
│   ├── README.md               # Documentation index
│   └── guides/                 # Comprehensive guides
│       ├── testing.md         # Testing strategy
│       ├── testing-framework.md # Testing framework details
│       ├── testing-quick-reference.md # Quick reference
│       ├── performance.md     # Performance optimization
│       ├── visual-regression.md # Visual testing
│       └── content-creation.md # Content guidelines
├── scripts/                      # Utility scripts
│   ├── start-runner.sh        # Start Gitea runner
│   ├── status-runner.sh       # Check runner status
│   └── stop-runner.sh         # Stop Gitea runner
├── tests/                        # Test files
│   ├── unit/                   # Unit tests
│   ├── integration/            # Integration tests
│   ├── e2e/                    # E2E tests
│   └── accessibility/          # Accessibility tests
├── .storybook/                  # Storybook configuration
├── .gitea/                      # Gitea Actions workflows
│   └── workflows/
│       └── ci.yaml            # CI/CD pipeline
└── public/                      # Static assets

🔧 Technology Stack

• Framework: Next.js 15 + React 19
• Styling: Tailwind CSS 4
• Testing: Vitest + Playwright + Lighthouse CI
• Documentation: Storybook 9
• CI/CD: Gitea Actions
• Hosting: Gitea (Git hosting)

📖 Documentation

• Documentation Index - Complete documentation guide
• Testing Guides - Testing strategy, framework, and quick reference
• Performance Guide - Performance optimization guide
• Visual Regression Guide - Visual testing guide
• Storybook - Component documentation (local)

🤝 Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Write tests first (see Testing Guide)
4. Make your changes
5. Run tests: npm test && npm run e2e
6. Commit changes: git commit -m "feat: add amazing feature"
7. Push to branch: git push origin feature/amazing-feature
8. Create Pull Request

Development Workflow

• All changes must have tests
• CI pipeline runs automatically on PRs
• Visual regression tests ensure UI consistency
• Performance budgets must be met
• Accessibility standards must be maintained

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.