create-rn-folder-structure 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +82 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,39 +1,93 @@
|
|
|
1
|
+
# 📦 create-rn-folder-structure
|
|
1
2
|
|
|
2
|
-
|
|
3
|
+
A lightweight CLI tool that automatically generates a **clean, scalable,
|
|
4
|
+
and production-ready folder structure** for React Native projects.
|
|
3
5
|
|
|
4
|
-
This
|
|
6
|
+
This tool helps you quickly bootstrap a well-organized architecture so
|
|
7
|
+
you can focus on writing features---not setting up directories.
|
|
5
8
|
|
|
6
|
-
|
|
9
|
+
------------------------------------------------------------------------
|
|
7
10
|
|
|
11
|
+
## 🚀 Features
|
|
12
|
+
|
|
13
|
+
- 📁 Generates a modern, opinionated React Native folder structure\
|
|
14
|
+
- 🔌 Auto-creates feature modules (screens, store, API)\
|
|
15
|
+
- 🧩 Shared components, constants, hooks, and utilities\
|
|
16
|
+
- 📡 Centralized API configuration\
|
|
17
|
+
- 💾 Async storage service helpers\
|
|
18
|
+
- ⚡ Fast, simple, and zero-dependency CLI
|
|
19
|
+
|
|
20
|
+
------------------------------------------------------------------------
|
|
21
|
+
|
|
22
|
+
## 📦 Installation
|
|
23
|
+
|
|
24
|
+
Install the package globally:
|
|
25
|
+
|
|
26
|
+
``` sh
|
|
27
|
+
npm install -g create-rn-folder-structure
|
|
8
28
|
```
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
│ ├── auth/
|
|
15
|
-
│ ├── profile/
|
|
16
|
-
│ ├── dashboard/
|
|
17
|
-
│ └── settings/
|
|
18
|
-
├── shared/
|
|
19
|
-
│ ├── components/
|
|
20
|
-
│ ├── constants/
|
|
21
|
-
│ ├── custom-hooks/
|
|
22
|
-
│ └── utils/
|
|
23
|
-
├── services/
|
|
24
|
-
│ ├── api/
|
|
25
|
-
│ └── storage/
|
|
29
|
+
|
|
30
|
+
Or use **npx** (recommended):
|
|
31
|
+
|
|
32
|
+
``` sh
|
|
33
|
+
npx create-rn-folder-structure
|
|
26
34
|
```
|
|
27
35
|
|
|
28
|
-
|
|
36
|
+
------------------------------------------------------------------------
|
|
37
|
+
|
|
38
|
+
## 🛠️ Usage
|
|
39
|
+
|
|
40
|
+
Run inside your React Native project:
|
|
41
|
+
|
|
42
|
+
``` sh
|
|
43
|
+
npx create-rn-folder-structure
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
------------------------------------------------------------------------
|
|
47
|
+
|
|
48
|
+
## 📁 Generated Folder Structure
|
|
49
|
+
|
|
50
|
+
src/
|
|
51
|
+
├── app/
|
|
52
|
+
│ ├── navigation/
|
|
53
|
+
│ └── store/
|
|
54
|
+
├── features/
|
|
55
|
+
│ ├── auth/
|
|
56
|
+
│ ├── profile/
|
|
57
|
+
│ ├── dashboard/
|
|
58
|
+
│ └── settings/
|
|
59
|
+
├── shared/
|
|
60
|
+
│ ├── components/
|
|
61
|
+
│ ├── constants/
|
|
62
|
+
│ ├── custom-hooks/
|
|
63
|
+
│ └── utils/
|
|
64
|
+
├── services/
|
|
65
|
+
│ ├── api/
|
|
66
|
+
│ └── storage/
|
|
67
|
+
|
|
68
|
+
------------------------------------------------------------------------
|
|
69
|
+
|
|
70
|
+
## ✨ What Gets Generated?
|
|
71
|
+
|
|
72
|
+
✔ Feature screens\
|
|
73
|
+
✔ Base API service\
|
|
74
|
+
✔ Centralized store structure\
|
|
75
|
+
✔ Shared UI components folder\
|
|
76
|
+
✔ Custom hooks folder\
|
|
77
|
+
✔ App-level constants & utilities\
|
|
78
|
+
✔ Typed folder layout (if using TS)
|
|
79
|
+
|
|
80
|
+
------------------------------------------------------------------------
|
|
81
|
+
|
|
82
|
+
## 🤝 Contributing
|
|
83
|
+
|
|
84
|
+
Contributions are welcome!
|
|
85
|
+
|
|
86
|
+
------------------------------------------------------------------------
|
|
29
87
|
|
|
30
|
-
|
|
31
|
-
- Shared UI Components
|
|
32
|
-
- Custom Hooks
|
|
33
|
-
- Constants
|
|
34
|
-
- Centralized API setup
|
|
35
|
-
- Async storage helpers
|
|
88
|
+
## ❤️ Author
|
|
36
89
|
|
|
37
|
-
|
|
90
|
+
1. Sandhip Kumar Dhall
|
|
91
|
+
2. Hriday Kaushal
|
|
38
92
|
|
|
39
93
|
Generated with ❤️ using **create-rn-folder-structure**
|