NextJS Base Documentation Center
Organized by the path: "Understand Project → Start Project → Use Admin → Advanced Development → Troubleshooting", prioritizing practical implementation and problem-solving.
🧭 Recommended Reading Order
- Understand Project: Quickly understand capabilities and architecture
- Start Project: Get local environment and admin running in 10 minutes
- Use Admin: Complete common tasks (CRUD, permissions, menus) by module
- Advanced Development: Integrate database, encapsulate Actions, field configuration API
- Troubleshooting/FAQ: Check troubleshooting checklist when encountering issues
1) Understand Project
Overall Architecture
System architecture, core components, and design trade-offs
Data Flow Design
Complete flow from request to database
Permission Model
RBAC model and layered approach
2) Start Project
Quick Start
Complete environment setup and project startup in 10 minutes
Project Structure
Directory and naming conventions for app/(client) and (admin)
First Admin Page
Build CRUD pages with SmartCrudPage
3) Use Admin (Out of the Box)
Admin Overview
Admin information architecture, core modules, and entry points
SmartCrudPage
Configuration-driven universal table/detail/operations
SmartForm
Form configuration, validation, and interaction patterns
Server Actions
Encapsulation, authentication, logging, and error handling
RBAC Configuration
Complete integration process for roles, permissions, and menus
Menu Management
Best practices for sidebar navigation and permission mapping
4) Advanced & Extension
Prisma Practice
Database models, migrations, and practical recommendations
Authentication System
Admin login, permission verification, and sessions
Internationalization
Multi-language configuration, routing, and content organization
fieldsConfig Reference
Complete API documentation for field configuration
nb.pubfn
Quick overview of common function library
5) Troubleshooting & FAQ
6) Contribute
Contributing Guide
Learn how to participate in project development
Submit PR
Branch conventions and Pull Request process
Submit Issue
Correct way to report bugs and suggest features
💬 Join Community
Welcome to join our community to exchange questions, share experiences, and get the latest updates!
Scan to add my WeChat, I'll add you to the group