create-next-custom-app
v1.2.3
Published
A CLI tool designed to simplify the creation of Next.js applications with custom configurations.
Downloads
620
Maintainers
Readme
CNCA: create-next-custom-app
Created with ❤️️ by mntcodes.com
create-next-custom-app
is a CLI tool designed to simplify the creation of Next.js applications with custom configurations. It allows developers to choose from a wide range of popular libraries and tools, streamlining the setup process without requiring manual configuration.
🚀 Features
- Custom Configuration: Choose from a selection of popular libraries such as:
- UI Components Libraries: Shadcn/ui, ChakraUI
- Databases & ORMs: Prisma, TypeORM, Mongoose
- State Management: React Query
- UI Frameworks: Storybook, Framer Motion
- Form Handling: Formik, React-hook-form
- Schema Validation: Yup, Zod
- Authentication: Next Auth
- Testing: Jest, Cypress, React Testing Library
- Linting & Formatting: Husky, Commitlint, Lint-Staged, Prettier
- And more!!!
Built on Create Next App: Utilizes
create-next-app
in the background to set up the initial project structure.Zero Configuration Required: Automatically installs and configures selected dependencies, creating all necessary configuration files. You don't need to worry about manual setup!
📦 Installation
You can use npx
to create a new Next.js project with custom configurations directly from the command line:
npx create-next-custom-app
💻 Usage
Run the CLI: Execute the following command in your terminal:
npx create-next-custom-app
Follow the Prompts:
- You will be greeted with a welcome message.
- Choose from a list of libraries you want to include in your project.
- The tool will then create a new Next.js application and install the selected libraries.
Automatic Configuration: After installation,
create-next-custom-app
will automatically generate configuration files based on your selections, saving you time and effort.
📚 Example Libraries
Here are some examples of libraries you can choose from during the setup:
- Shadcn/ui: For UI components library.
- Chakra UI: For UI components library.
- Zod: For schema validation.
- Yup: For schema validation.
- Prisma: For ORM and database interactions.
- React Query: For data fetching and state management.
- Storybook: For UI component development.
- Formik: For form handling.
- Next Auth: For authentication.
- Framer Motion: For animations.
- Jest: For unit testing.
- Cypress: For end-to-end testing.
- React Testing Library: For testing React components.
- Husky: For Git hooks and pre-commit checks.
- Commitlint: For linting commit messages.
- Lint-Staged: For linting files in Git.
We're curently working on adding more and more !
🤝 Open Source Contributions
We believe in the power of community and collaboration! As create-next-custom-app
evolves, we want to hear from you.
💡 Share Your Ideas
If you have suggestions for libraries or tools that you frequently use and would like to see integrated into the CLI app, please let us know! Your input is invaluable in making this tool more versatile and user-friendly.
🤝 How to Contribute
- Open an Issue: If there's a library you'd like to recommend, please open an issue in our GitHub repository. Provide details about the library and why you think it should be included.
- Submit a Pull Request: If you're interested in contributing code, feel free to submit a pull request! We welcome contributions that enhance the functionality and usability of the CLI tool.
- Join the Discussion: Engage with other contributors and users in the issues section to discuss potential libraries, configurations, and improvements.
Together, we can build a powerful tool that meets the needs of developers everywhere. Thank you for your support and contributions!
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
💖 Acknowledgments
- Thanks to the maintainers of Next.js and the various libraries that make this tool possible.
- Special thanks to the community for their continuous support and feedback.
💬 Contact
Feel free to reach out for any questions or suggestions!