Skip to content

Colten-Covington/Buzz-Stack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Buzz Stack ⚑

A modern, production-ready Next.js 16.1.6 boilerplate with React 19, TypeScript 5.7.2, and Tailwind CSS 3.4. Built with best practices, accessibility, and developer experience in mind.

Perfect for bootstrapping your next web application quickly without sacrificing quality.


  • ✨ Features

  • ⚑ Next.js 16.1.6 - App Router with Turbopack, Server Actions, and the use cache directive
  • βš›οΈ React 19 - Concurrent rendering, Compiler optimizations, and Server Actions
  • πŸ“˜ TypeScript 5.7.2 - Strict mode with advanced generics and utility types
  • 🎨 Tailwind CSS - Utility-first CSS with custom configuration
  • β™Ώ Accessible - WCAG 2.2 AA compliant out of the box
  • πŸ—οΈ Well-Structured - Organized folder structure with clear separation of concerns
  • πŸ“¦ pnpm - Fast, disk space efficient package manager
  • πŸ”§ ESLint 9 - Code quality, linting, and modern flat config
  • 🎯 Production-Ready - Error boundaries, loading states, and 404 pages included

πŸš€ Quick Start

Prerequisites

  • Node.js 18.0 or higher
  • pnpm 9.0.0 or higher (recommended) or npm/yarn

Installation

  1. Clone or use as template:
git clone https://github.com/yourusername/buzz-stack.git my-app
cd my-app
  1. Install dependencies:
pnpm install
  1. Run development server:
pnpm dev
  1. Open your browser: Visit http://localhost:3000

Building for Production

pnpm build    # Build for production
pnpm start    # Start production server
pnpm lint     # Run ESLint

πŸ“ Project Structure

buzz-stack/
β”œβ”€β”€ app/                 # Next.js App Router
β”‚   β”œβ”€β”€ layout.tsx      # Root layout with metadata
β”‚   β”œβ”€β”€ page.tsx        # Home page
β”‚   β”œβ”€β”€ error.tsx       # Error boundary
β”‚   β”œβ”€β”€ loading.tsx     # Loading UI
β”‚   β”œβ”€β”€ not-found.tsx   # 404 page
β”‚   └── globals.css     # Global styles
β”œβ”€β”€ components/          # Reusable React components
β”‚   β”œβ”€β”€ Header.tsx
β”‚   └── GitHubLink.tsx
β”œβ”€β”€ hooks/              # Custom React hooks
β”‚   └── useModal.ts     # Example modal hook
β”œβ”€β”€ lib/                # External API clients and integrations
β”œβ”€β”€ services/           # Business logic and orchestration
β”œβ”€β”€ utils/              # Pure utility functions
β”œβ”€β”€ types/              # TypeScript type definitions
β”œβ”€β”€ constants/          # App-wide constants
β”œβ”€β”€ contexts/           # React Context providers
β”œβ”€β”€ middleware/         # Next.js middleware
β”œβ”€β”€ public/             # Static assets
└── docs/               # Documentation

Directory Purpose

  • /app - Next.js 16 App Router pages, layouts, and special files
  • /components - Reusable UI components with props interfaces
  • /hooks - Custom React hooks for stateful logic
  • /lib - Third-party integrations and API clients
  • /services - Business logic layer with caching and orchestration
  • /utils - Pure functions and helpers
  • /types - Shared TypeScript interfaces and types
  • /constants - Configuration and constant values
  • /contexts - React Context for global state
  • /middleware - Next.js Edge middleware
  • /public - Static files served from root

🎨 Customization

Update Branding

Edit the header in components/Header.tsx:

<Header title="Your App Name" subtitle="Your tagline" emoji="πŸš€" />

Edit metadata in app/layout.tsx:

export const metadata: Metadata = {
  title: "Your App Name",
  description: "Your app description",
  // ... other metadata
};

Configure GitHub Link

Update components/GitHubLink.tsx or pass props:

<GitHubLink
  repoUrl="https://github.com/yourusername/yourrepo"
  label="View on GitHub"
/>

Styling

  • Tailwind Config: Edit tailwind.config.ts for theme customization
  • Global Styles: Add CSS to app/globals.css
  • Gradient Background: Modify gradient in app/page.tsx

πŸ“š Documentation

For Developers

  • AGENTS.md - Architecture, code style, and best practices (AI-friendly format)
  • CONTRIBUTING.md - Contribution guidelines
  • docs/ - Comprehensive documentation
    • Architecture patterns
    • Code structure guide
    • Development best practices
    • Next.js and Vercel features

For AI Coding Assistants

This project follows the Agentic AI Foundation standard:


πŸ—οΈ Architecture

Layered Architecture

UI Layer (Components)
    ↓
React Integration (Hooks)
    ↓
Business Logic (Services)
    ↓
External APIs (Lib)

Key Patterns

  • Server Components by default - Use 'use client' only when needed
  • Type Safety - Strict TypeScript with explicit types
  • Accessibility First - Semantic HTML, ARIA attributes, keyboard navigation
  • Performance - Code splitting, lazy loading, optimized images
  • Separation of Concerns - Clear boundaries between layers

πŸ› οΈ Tech Stack

Technology Version Purpose
Next.js 16.1.6 React framework with App Router, Turbopack, and Server Actions
React 19.2.4 UI library with concurrent rendering and compiler optimizations
TypeScript 5.7.2 Type-safe JavaScript with strict mode and advanced generics
Tailwind CSS 3.4.0 Utility-first CSS framework with full configuration
pnpm 9.0.0 Fast, disk-efficient package manager
ESLint 9 Code quality linting with flat config

🚦 What's Included

Next.js Features

  • βœ… App Router with layouts
  • βœ… Server Components by default
  • βœ… Error boundaries (error.tsx)
  • βœ… Loading states (loading.tsx)
  • βœ… 404 page (not-found.tsx)
  • βœ… Metadata API for SEO
  • βœ… Viewport configuration

UI/UX Features

  • βœ… Responsive design (mobile-first)
  • βœ… Keyboard navigation
  • βœ… Screen reader support
  • βœ… Focus indicators
  • βœ… Skip to main content link
  • βœ… Beautiful gradient background
  • βœ… Glassmorphism effects

Developer Experience

  • βœ… TypeScript strict mode
  • βœ… ESLint configuration
  • βœ… Clear project structure
  • βœ… Example components and hooks
  • βœ… Comprehensive documentation
  • βœ… AI-friendly AGENTS.md files

πŸ”¨ Building Your App

Step 1: Customize the Home Page

Edit app/page.tsx to create your landing page or dashboard.

Step 2: Add Components

Create reusable components in /components:

// components/Button.tsx
interface ButtonProps {
  label: string;
  onClick: () => void;
}

export default function Button({ label, onClick }: ButtonProps) {
  return (
    <button
      onClick={onClick}
      className="px-4 py-2 bg-blue-500 hover:bg-blue-600 rounded"
    >
      {label}
    </button>
  );
}

Step 3: Add Routes

Create new pages by adding files to /app:

app/
β”œβ”€β”€ page.tsx           # Home page (/)
β”œβ”€β”€ about/
β”‚   └── page.tsx      # About page (/about)
└── dashboard/
    └── page.tsx      # Dashboard page (/dashboard)

Step 4: Add Business Logic

  1. API Clients (/lib) - External API integrations
  2. Services (/services) - Business logic with caching
  3. Hooks (/hooks) - React state management
  4. Utils (/utils) - Pure helper functions

🀝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.


πŸ“„ License

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


πŸ™ Acknowledgments

  • Built with Next.js
  • Styled with Tailwind CSS
  • Icons from emoji unicode
  • Inspired by modern web development best practices

πŸ†˜ Need Help?


Happy coding! ⚑ Start building amazing things with Buzz Stack.

About

Buzz Stack Boiler Plate

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors