create-react-screaming-app
v1.0.0
Published
A modern React CLI template generator with screaming architecture, TypeScript, TailwindCSS, Shadcn/ui components, and comprehensive CRUD operations
Maintainers
Readme
Create React Screaming App
🚀 A modern React CLI template generator with screaming architecture
🌟 Quick Start
# Install globally
npm install -g create-react-screaming-app
# Create a new project
create-react-screaming-app my-awesome-app
# Or use npx (recommended)
npx create-react-screaming-app my-awesome-app✨ What You Get
A complete React application template with:
🏗️ Architecture
- Screaming Architecture - Feature-based folder structure
- TypeScript - Full type safety
- Vite - Fast build tool and dev server
🎨 Styling & UI
- TailwindCSS - Utility-first CSS framework
- Shadcn/ui - Beautiful, accessible components
- Dark/Light mode support via CSS variables
- Responsive design with mobile-first approach
🛠️ Development Tools
- React Router - Client-side routing
- React Icons - Comprehensive icon library
- ESLint - Code linting
- Path aliases (
@/) - Clean imports
📡 Data & Services
- Axios - HTTP client with service layer
- CRUD operations - Ready-to-use examples
- Authentication - Token handling
- Error handling - Request/response interceptors
📱 Features Included
- Dashboard with analytics cards
- User management with search and filtering
- Product catalog with inventory management
- Navigation with active states
📁 Generated Project Structure
my-awesome-app/
├── src/
│ ├── features/ # Feature modules
│ │ ├── dashboard/ # Dashboard feature
│ │ ├── users/ # User management
│ │ └── products/ # Product catalog
│ ├── shared/ # Shared utilities
│ │ ├── components/ # Reusable components
│ │ ├── services/ # API services
│ │ └── utils/ # Helper functions
│ ├── pages/ # Page components
│ └── lib/ # Library configs
├── .env.example # Environment variables
├── tailwind.config.js # Tailwind configuration
└── components.json # Shadcn/ui config🚀 Usage Examples
Basic Usage
npx create-react-screaming-app my-projectInteractive Mode
npx create-react-screaming-app
# CLI will prompt for project name🛠️ Development Workflow
After creating your project:
cd my-awesome-app
npm install
npm run dev # Start development server
npm run build # Build for production
npm run preview # Preview production build🎯 Use Cases
Perfect for:
- 💼 Business applications with CRUD operations
- 📊 Admin dashboards with data visualization
- 🛍️ E-commerce platforms with product management
- 👥 User management systems
- 🏢 Enterprise applications requiring scalable architecture
🔧 Customization
The generated template includes:
- Environment variables (
.env.example) - Service examples for Users and Products
- Mock data for immediate development
- Responsive components ready for customization
- Type definitions for all features
📚 Next Steps
- Explore features: Check out Users and Products pages
- Customize styling: Modify TailwindCSS configuration
- Add new features: Follow the screaming architecture pattern
- Connect to API: Update service endpoints in
.env - Deploy: Build and deploy to your preferred platform
🤝 Contributing
Found a bug or have a feature request? Please open an issue on our GitHub repository.
📄 License
MIT License - see LICENSE file for details.
Built with ❤️ for modern React development
