rnsup 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +44 -75
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,8 +1,13 @@
1
+ <img width="1536" height="1024" alt="1000241861" src="https://github.com/user-attachments/assets/3a35bc32-3413-40e5-8355-5db4806923a4" />
2
+
3
+
1
4
  # RNSUP — React Native Support CLI
2
5
 
6
+ ![npm](https://img.shields.io/npm/v/rnsup?color=blue&label=npm)&nbsp;![license](https://img.shields.io/badge/license-MIT-green)&nbsp;![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)
7
+
3
8
  **RNSUP** is a developer productivity CLI that converts a fresh React Native CLI project into a production-ready architecture.
4
9
 
5
- Instead of spending 23 days configuring navigation, alias paths, reanimated, gesture handler, axios setup and folder structure, you can do everything with **one command**.
10
+ Instead of spending 36 hours configuring navigation, alias paths, reanimated, gesture handler, axios setup and folder structure, you can do everything with **one command**.
6
11
 
7
12
  ---
8
13
 
@@ -60,6 +65,37 @@ src/
60
65
  * Image import TypeScript support
61
66
  * Clean folder structure
62
67
 
68
+ ---
69
+
70
+ ## Installed packages (default)
71
+
72
+ RNSUP installs a curated set of libraries into your project. These are added automatically when you run `npx rnsup setup` (some are optional via prompt):
73
+
74
+ - `@react-navigation/native`
75
+ - `react-native-screens`
76
+ - `react-native-gesture-handler`
77
+ - `react-native-reanimated`
78
+ - `react-native-worklets` (Babel plugin integration)
79
+ - `react-native-vector-icons`
80
+ - `zustand`
81
+ - `axios`
82
+ - `@tanstack/react-query`
83
+ - `react-native-mmkv`
84
+ - navigation extras (conditional): `@react-navigation/native-stack`, `@react-navigation/bottom-tabs`, `@react-navigation/drawer`
85
+ - optional (prompted): `react-native-svg`, `lucide-react-native`
86
+
87
+ <div style="background:#fff3cd;border-left:6px solid #ffeeba;padding:12px;border-radius:6px">
88
+ <strong>⚠️ Warning</strong>
89
+ <p style="margin:6px 0 0">Many of the packages above include native code. After installation you <strong>must</strong> verify and complete any required native configuration (for iOS and Android). Common steps include:</p>
90
+ <ul style="margin:6px 0 0;padding-left:20px">
91
+ <li>Run <code>cd ios && pod install</code> on macOS</li>
92
+ <li>Follow the official docs for Reanimated, MMKV, react-native-svg and React Navigation</li>
93
+ <li>Check Android Gradle / manifest changes for native modules</li>
94
+ </ul>
95
+ <p style="margin:6px 0 0">If something looks off (build errors, missing icons, or runtime crashes), consult the package docs first — RNSUP does not (and cannot) run platform-specific installs for you.</p>
96
+ </div>
97
+
98
+ ---
63
99
  ### Developer Experience
64
100
 
65
101
  * Auto import aliases (`@components`, `@services`, etc.)
@@ -83,9 +119,10 @@ npx rnsup setup
83
119
  ## Quick Start
84
120
 
85
121
  ### 1) Create React Native Project
122
+ for creating latest cli project !
86
123
 
87
124
  ```bash
88
- npx react-native@latest init MyApp
125
+ npx create-rn
89
126
  cd MyApp
90
127
  ```
91
128
 
@@ -120,6 +157,9 @@ npx rnsup setup
120
157
 
121
158
  ### Generate Screen
122
159
 
160
+ > Here `s` mean `screen`, and `g` mean `generate`
161
+
162
+
123
163
  ```
124
164
  rnsup g s Login
125
165
  rnsup g s auth/Login
@@ -138,6 +178,8 @@ src/features/auth/LoginScreen.tsx
138
178
 
139
179
  ### Generate Component
140
180
 
181
+ > Here `c` mean `component`
182
+
141
183
  ```
142
184
  rnsup g c Button
143
185
  rnsup g c ui/forms/Input
@@ -244,79 +286,6 @@ Recommended workflow:
244
286
 
245
287
  This ensures aliases and exports always remain correct.
246
288
 
247
- ---
248
-
249
- ## Publishing to NPM
250
-
251
- ### 1) Login
252
-
253
- Create an account at:
254
- https://www.npmjs.com
255
-
256
- Then:
257
-
258
- ```bash
259
- npm login
260
- ```
261
-
262
- ---
263
-
264
- ### 2) Prepare package.json
265
-
266
- Make sure:
267
-
268
- ```json
269
- {
270
- "name": "rnsup",
271
- "version": "1.0.0",
272
- "bin": {
273
- "rnsup": "bin/rnsup.js"
274
- }
275
- }
276
- ```
277
-
278
- ---
279
-
280
- ### 3) Build project
281
-
282
- ```
283
- npm run build
284
- ```
285
-
286
- ---
287
-
288
- ### 4) Publish
289
-
290
- ```
291
- npm publish --access public
292
- ```
293
-
294
- Your package is now live.
295
-
296
- ---
297
-
298
- ## Using After Publish
299
-
300
- Anyone can run:
301
-
302
- ```bash
303
- npx rnsup setup
304
- ```
305
-
306
- No installation required.
307
-
308
- ---
309
-
310
- ## Updating Package
311
-
312
- After changes:
313
-
314
- ```
315
- npm version patch
316
- npm publish
317
- ```
318
-
319
- ---
320
289
 
321
290
  ## Contribution
322
291
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rnsup",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "RNSUP is a CLI tool that converts a fresh React Native CLI project into a production-ready architecture with navigation, alias paths, utilities and code generators.",
5
5
  "main": "dist/index.js",
6
6
  "type": "commonjs",
@@ -64,4 +64,4 @@
64
64
  "ts-node": "^10.9.2",
65
65
  "typescript": "^5.9.3"
66
66
  }
67
- }
67
+ }