Skip to content

Latest commit

 

History

History

README.md

Next.js SaaS AI Template — Documentation

This folder is the single source of truth for the Next.js SaaS AI Template. AI agents should use AGENTS.md as an index; humans and agents read these docs for authoritative content.

Core Documentation

Document Description
Project Structure Architecture, folder organization, and feature modules
Design System Design philosophy, principles, tokens, and visual identity
Brand Guidelines Logo, color palette, typography, do's and don'ts
Components & Styling shadcn/ui components and Tailwind CSS v4 patterns
shadcn/ui Components Component inventory, forms, theming, and adding new ones
Storybook Storybook setup, writing stories, and troubleshooting
Database Drizzle ORM schema and pgvector setup
Authentication Auth.js v5 configuration and patterns
Roles and Permissions PBAC model, roles, permissions, and API
State Management State handling approaches
Performance Optimization guidelines
Project Configuration Build tools and configuration
Testing Guide Jest and React Testing Library patterns
API Reference REST API routes and contracts
Integrations Third-party OAuth2/API integrations (e.g. GitHub)
Deployment Deployment and infrastructure
GitHub Setup Guide CI/CD and GitHub workflows
Glossary Terms, concepts, and domain vocabulary