next-project-scaffolder
v1.0.3
Published
π The ultimate React/Next.js project scaffolder with authentication, theming, UI libraries, role-based authorization, and seamless backend integration
Maintainers
Keywords
Readme
Next Project Scaffolder
π The ultimate Next.js project scaffolder - Create production-ready React applications with authentication, theming, UI libraries, role-based authorization, and seamless backend integration in seconds!
β¨ Features
- π Complete Authentication System - NextAuth.js with OAuth providers (Google, GitHub) + credentials
- π Two-Factor Authentication - Optional 2FA setup with QR codes
- π Dark/Light Theming - Built-in theme switching with next-themes
- π¨ Multiple UI Libraries - Tailwind CSS, shadcn/ui, Material-UI, Chakra UI support
- πͺ Role-Based Access Control - Admin/user roles with protected routes
- ποΈ Database Integration - Prisma, Drizzle ORM, MongoDB ready
- π API Middlewares - Authentication, CORS, rate limiting included
- β‘ Modern Stack - Next.js 14, TypeScript, App Router, Server Components
- π§ Professional Tooling - ESLint, Prettier, VS Code settings, EditorConfig
- π± Responsive Design - Mobile-first approach with Tailwind CSS
π Quick Start
NPM (Recommended)
# Create a new project (interactive mode)
npx next-project-scaffolder
# Quick setup with defaults
npx react-quick my-awesome-appGlobal Installation
npm install -g next-project-scaffolder
# Then use anywhere
next-project-scaffolder
react-quick my-projectLocal Development
git clone https://github.com/yourusername/next-project-scaffolder.git
cd next-project-scaffolder
node bin/create-react-project.js㪠Demo
Watch the scaffolder in action:
npx next-project-scaffolder my-appAnswer the prompts:
- Project name:
my-app - TypeScript:
Yes - UI Library:
shadcn/ui - Authentication:
Yes - Google OAuth:
Yes - GitHub OAuth:
Yes - 2FA:
Yes - Theming:
Yes - Database:
Prisma - README:
Yes - Package manager:
npm - Install deps:
Yes - Git init:
Yes
Result: A fully-featured Next.js app with auth, theming, and database ready!
π± Generated Project Structure
my-app/
βββ src/
β βββ app/ # Next.js 14 App Router
β β βββ auth/ # Auth pages (signin, register, 2fa)
β β βββ dashboard/ # Protected dashboard
β β βββ api/ # API routes with auth middleware
β β β βββ auth/ # NextAuth configuration
β β βββ layout.tsx # Root layout with providers
β β βββ page.tsx # Home page
β βββ components/ # React components
β β βββ providers/ # Theme & Auth providers
β β βββ auth/ # Auth guards & utilities
β β βββ ui/ # UI components
β βββ lib/ # Utilities & middleware
β βββ styles/ # Global styles
βββ prisma/ # Database schema
βββ middleware.ts # Route protection
βββ .env.local # Environment variables
βββ Configuration files (next, tailwind, typescript)π Authentication Features
- NextAuth.js Integration - Industry standard authentication
- Multiple Providers - Google, GitHub, and credentials
- Role-Based Access - Admin/user roles with permissions
- Protected Routes - Middleware-based route protection
- 2FA Support - Optional two-factor authentication
- Session Management - Secure JWT sessions
- API Authentication - Middleware for API routes
Demo credentials:
- Email:
[email protected] - Password:
password123 - Role:
admin
π¨ UI Library Support
Tailwind CSS
- Utility-first CSS framework
- Dark mode support
- Responsive design
shadcn/ui
- Beautiful components built on Radix UI
- Fully customizable
- TypeScript support
Material-UI
- Google's Material Design
- Comprehensive component library
- Theme system
Chakra UI
- Simple and modular
- Accessible components
- Easy theming
ποΈ Database Options
Prisma
- Type-safe database access
- Automatic migrations
- Visual database browser
Drizzle ORM
- Lightweight TypeScript ORM
- SQL-like syntax
- Edge runtime compatible
MongoDB
- NoSQL database
- Mongoose integration
- Flexible schema
π What You Get
π± Complete App
- β Authentication system with OAuth
- β Dark/light theme toggle
- β Responsive dashboard
- β Protected API routes
- β Role-based permissions
- β Database integration
- β Production-ready configuration
π§ Development Tools
- β TypeScript configuration
- β ESLint & Prettier setup
- β VS Code settings
- β Git hooks ready
- β Environment variables
- β Build optimization
π Usage Examples
Create a SaaS Starter
npx next-project-scaffolder saas-app
# Choose: TypeScript, shadcn/ui, Auth with Google+GitHub, Prisma, 2FACreate an E-commerce Admin
npx next-project-scaffolder admin-panel
# Choose: TypeScript, Material-UI, Auth with roles, PrismaCreate a Blog Platform
npx next-project-scaffolder blog-platform
# Choose: TypeScript, Tailwind, Auth with GitHub, MongoDBπ Why Use This Scaffolder?
β¨ Save Hours of Setup - Get a production-ready app in minutes
π Security First - Built-in auth, CORS, rate limiting
π¨ Beautiful UI - Multiple design systems supported
πͺ Role-Based Access - Admin panels and user management
π Scalable - Professional folder structure and patterns
π§ Developer Experience - TypeScript, ESLint, Prettier included
π Perfect For
- π Startup MVPs - Get to market faster
- π’ Enterprise Projects - Professional structure and security
- π Learning - Best practices and modern patterns
- π₯ Team Development - Consistent project setup
π€ Contributing
We welcome contributions! Please see CONTRIBUTING.md for details.
- Fork the repository
- Create your feature branch:
git checkout -b feature/amazing-feature - Commit your changes:
git commit -m 'Add amazing feature' - Push to the branch:
git push origin feature/amazing-feature - Open a Pull Request
π License
MIT License - see LICENSE file for details.
π Author
Created with β€οΈ by Your Name
β Star this repository if it helped you!
