create-react-folder

1.0.2 • Public • Published

📂 Create React Folder Structure CLI

🌟 Description

Welcome to create-react-folder! This CLI tool is your quick fix to setting up a well-organized folder structure for React applications. It ensures that you can start your project with the best practices in folder organization, complete with .gitkeep files to keep your directories tidy in version control.

🚀 Features

  • Quick Setup: Get a complete folder structure set up with just one command.
  • Standardization: Ensures consistent folder architecture, making it easier for teams to collaborate.
  • .gitkeep Integration: Automatically adds .gitkeep files in empty directories.

📦 Installation

Ensure you have Node.js installed, then run the following command:

npx create-react-folder

Or, install it globally on your system:

npm install -g create-react-folder

🛠 Usage

Simply navigate to the root of your React project and execute:

npx create-react-folder

This will create the following structure:

📁 src
   ├── 📁 app
   │     ├── 📁 contexts
   │     ├── 📁 hook
   │     └── 📁 services
   ├── 📁 assets
   │     ├── 📁 icon
   │     └── 📁 images
   ├── 📁 components
   │     ├── 📁 core
   │     ├── 📁 router
   │     └── 📁 sections
   ├── 📁 constants
   ├── 📁 lib
   ├── 📁 pages
   └── 📁 util
📁 public

💬 Contributing

Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are immensely appreciated:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📜 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

👤 Author

  • Het Shah

🐞 Issues

Feel free to report issues or request new features.

📬 Contact

Package Sidebar

Install

npm i create-react-folder

Weekly Downloads

9

Version

1.0.2

License

Apache-2.0

Unpacked Size

15.8 kB

Total Files

4

Last publish

Collaborators

  • het_shah