nextjs-project-scaffolder
v1.0.0
Published
CLI tool for scaffolding professional Next.js project folder structures
Downloads
4
Maintainers
Readme
🚀 Next.js Project
A professional Next.js application with a well-organized folder structure.
✨ Features
- 🎯 Modern Next.js setup
- 📁 Professional folder structure
- 🎨 Ready for styling (CSS/Tailwind)
- 🔧 TypeScript ready
- 📱 Responsive design ready
🚀 Quick Start
Prerequisites
- Node.js 18+
- npm or yarn
Installation
# Install dependencies
npm install
# Start development server
npm run devOpen http://localhost:3000 to view it in the browser.
📁 Project Structure
app/
├── components/ # Reusable UI components
│ ├── ui/ # Basic UI elements (buttons, inputs, etc.)
│ ├── forms/ # Form components
│ └── layout/ # Layout components (header, footer, etc.)
├── lib/ # Utility libraries and configurations
├── hooks/ # Custom React hooks
├── types/ # TypeScript type definitions
├── styles/ # Global styles and CSS modules
└── utils/ # Helper functions and utilities
public/
├── assets/
│ ├── images/ # Static images
│ └── icons/ # Icon files
docs/ # Project documentation
tests/ # Test files🛠️ Available Scripts
# Development
npm run dev # Start development server
npm run build # Build for production
npm run start # Start production server
# Code Quality
npm run lint # Run ESLint
npm run type-check # Run TypeScript checks🎨 Styling
This project is ready for your preferred styling solution:
- CSS Modules
- Tailwind CSS
- Styled Components
- Emotion
📚 Learn More
🤝 Contributing
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
📜 License
This project is licensed under the MIT License.
"Great projects start with great structure."
Built with ❤️ using Next.js
