Home - mustafagenc/nitrokit GitHub Wiki

Welcome to the Nitrokit Documentation! This is your comprehensive guide to building modern web applications with our Next.js 15 starter kit.

🌟 What is Nitrokit?

Nitrokit is a production-ready Next.js 15 starter kit that combines the best tools and practices for building scalable, modern web applications. It features TailwindCSS v4, Storybook 8.4, TypeScript, and a comprehensive component library.

🚀 Quick Start

# Clone the repository
git clone https://github.com/mustafagenc/nitrokit.git
cd nitrokit

# One-click setup
./shell/dev_setup.sh

# Start development
yarn dev

# Start Storybook
yarn storybook

🎯 Complete Setup Guide →

📚 Documentation Structure

🏗️ Getting Started

Setup Guide - Complete installation and configuration
Project Structure - Understanding the codebase
Environment Setup - Configure your development environment
First Steps - Build your first component

🎨 Component Development

Storybook Guide - Interactive component development
Component Library - Pre-built UI components
Design System - Design tokens and guidelines
Creating Components - Step-by-step component creation

🛠️ Core Features

Authentication - NextAuth.js setup and usage
Database - Prisma ORM and database management
Internationalization - Multi-language support
Styling - TailwindCSS v4 and theming

🚀 Advanced Topics

Performance - Optimization techniques
Testing - Unit, integration, and E2E testing
Deployment - Production deployment guides
CI/CD - Continuous integration and deployment

🔧 Development Tools

Scripts and Automation - Shell scripts and workflows
Code Quality - ESLint, Prettier, and best practices
Debugging - Development and production debugging
Troubleshooting - Common issues and solutions

🎯 Popular Topics

🏃‍♂️ Quick Actions

🎨 Component Examples

🛠️ Common Tasks

🏗️ Architecture Overview

nitrokit/
├── 🎨 Frontend Stack
│   ├── Next.js 15 (App Router, Server Components)
│   ├── React 18 (Suspense, Concurrent Features)
│   ├── TypeScript (Strict configuration)
│   └── TailwindCSS v4 (Utility-first styling)
│
├── 📖 Component Development
│   ├── Storybook 8.4 (Interactive development)
│   ├── Design System (Consistent UI patterns)
│   └── Component Library (Pre-built components)
│
├── 🔐 Backend & Database
│   ├── NextAuth.js (Authentication)
│   ├── Prisma ORM (Type-safe database)
│   └── API Routes (Server-side logic)
│
└── 🚀 Development & Deployment
    ├── Vercel (Optimal deployment)
    ├── GitHub Actions (CI/CD)
    └── Development Tools (ESLint, Prettier, Husky)

📊 Key Features

Feature	Description	Status
🎨 Component Library	50+ pre-built components with Storybook	✅ Ready
🌍 Internationalization	19 languages with RTL support	✅ Ready
🔐 Authentication	Multiple providers with NextAuth.js	✅ Ready
🗃️ Database	Prisma ORM with multiple DB support	✅ Ready
📱 Responsive Design	Mobile-first approach	✅ Ready
♿ Accessibility	WCAG 2.1 AA compliant	✅ Ready
⚡ Performance	Core Web Vitals optimized	✅ Ready
🧪 Testing	Unit, integration, E2E testing	✅ Ready

🎯 Use Cases

🏢 Enterprise Applications

SaaS Platforms - Multi-tenant applications with authentication
Admin Dashboards - Data-rich interfaces with charts and tables
E-commerce Sites - Product catalogs with internationalization
Content Management - Editorial interfaces with rich components

🚀 Startups & MVPs

Landing Pages - Marketing sites with modern design
Web Applications - Full-stack applications with database
API Dashboards - Developer tools and monitoring interfaces
Portfolio Sites - Personal or agency websites

🎓 Learning Projects

Component Libraries - Learn modern React patterns
Full-Stack Development - End-to-end application development
Design Systems - Consistent UI/UX implementation
Performance Optimization - Modern web performance techniques

🛣️ Learning Path

🟢 Beginner Path (New to Next.js/React)

Setup Guide - Get Nitrokit running
Project Structure - Understand the codebase
First Steps - Create your first component
Storybook Guide - Learn component development

🟡 Intermediate Path (Familiar with React)

Component Library - Explore existing components
Creating Components - Build custom components
Authentication - Add user authentication
Database - Work with data persistence

🔴 Advanced Path (Experienced developers)

Performance - Optimize for production
Testing - Implement comprehensive testing
CI/CD - Set up automated workflows
Contributing - Contribute back to Nitrokit

🔗 External Resources

🎨 Design & UI

⚡ Development

🔐 Authentication & Security

🚀 Deployment & DevOps

🤝 Community & Support

💬 Get Help

GitHub Discussions - Community Q&A
GitHub Issues - Bug reports and feature requests
Discord Community - Real-time chat and support

🎓 Learning Resources

Video Tutorials - Step-by-step guides
Blog Posts - In-depth articles
Example Projects - Real-world implementations

🤝 Contributing

Contributing Guide - How to contribute
Code of Conduct - Community guidelines
Development Setup - Local development environment

📈 What's New

✨ Current Release - v1.0.0

🎉 Initial Release - Production-ready Next.js 15 starter kit
🎨 TailwindCSS v4 - Latest utility-first CSS framework
⚡ Next.js 15 - App Router with Server Components and Turbopack
📖 Storybook 8.4 - Interactive component development environment
🌍 Internationalization - Support for 19 languages with RTL
🔐 Authentication - NextAuth.js with multiple providers
🗃️ Database Integration - Prisma ORM with PostgreSQL support
🧪 Testing Suite - Jest and Playwright for comprehensive testing
🚀 Deployment Ready - Optimized for Vercel with CI/CD

🔮 Roadmap

🌙 Dark Mode System - Automatic theme switching
📱 Mobile Components - Touch-optimized UI elements
🔧 CLI Tools - Component and page generators
📊 Analytics Dashboard - Built-in performance monitoring
🎯 SEO Optimization - Advanced meta tag management
🔌 Plugin System - Extensible architecture for third-party integrations

🎯 Recent Improvements

Performance - 90+ Lighthouse scores across all metrics
Accessibility - WCAG 2.1 AA compliance
Developer Experience - Hot reload, TypeScript strict mode
Code Quality - ESLint, Prettier, Husky pre-commit hooks
Documentation - Comprehensive Storybook stories and guides