create-react-native-airborne 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-native-airborne",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Scaffold a react-native-airborne starter project",
   "repository": {
     "type": "git",

package/template/README.md

@@ -1,113 +1,102 @@
-# React Native Airborne
+# __APP_NAME__
 
-React Native Airborne my opinionated mobile starter for folks who want to ship iOS/Android apps fast without repeating the same setup every project.
+This project was scaffolded with React Native Airborne.
 
-It includes a production-ready Expo client and a Convex backend.
-
-## 🧰 Stack
+## 🧰 What You Get
 
 - Bun workspaces monorepo (`client/`, `server/`)
 - Expo + Expo Router + Native Tabs (SDK 55)
 - Uniwind + Tailwind v4
-- Clerk authentication
+- Clerk auth flows
 - Convex backend + `convex-test`
-- Zustand + MMKV persistence
+- Zustand + MMKV for non-sensitive local preferences
 - Expo push notifications
-- Strict ESLint + Prettier setup
-
-## 🎯 Opinionated Defaults
+- Strict ESLint + Prettier + tests
 
-- Mobile-only target (iOS/Android), no web target in starter scope.
-- Expo prebuild supported for local native debugging, but `client/ios` and `client/android` are not committed.
-- Clerk + Convex integration wired from day one.
-- Theme system includes `light`, `dark`, and `system` with persisted preference.
-- Auth tokens are kept in secure storage flows, not MMKV.
-
-## 🗂️ Project Layout
+## 🗂️ Generated Project Layout
 
 ```text
 __APP_NAME__/
-  client/ # Expo app (Expo Router + Native Tabs)
-  server/ # Convex backend
+  client/  # Expo app
+  server/  # Convex backend
 ```
 
 ## ✅ Prerequisites
 
 - Bun `1.3.4+`
 - `just` command runner
-- Expo toolchain for iOS/Android simulators
-- Clerk app configured for native API
+- Expo toolchain for iOS/Android simulators/devices
+- Clerk app with native API enabled
 - Convex project/deployment
 
-## ⚡ Quickstart
+## ⚡ Quickstart (After Scaffolding)
 
 ```bash
+cd __APP_NAME__
 bun install --workspaces
 cp client/.env.example client/.env
 cp server/.env.example server/.env
 ```
 
-First-time Convex setup (one-time per new deployment):
+First-time Convex setup (once per deployment):
 
 ```bash
 cd server
 bun run dev
 ```
 
-Run both client and server:
+Then run app + backend together:
 
 ```bash
 just dev
 ```
 
-## 🧪 Commands
+## 🔐 Environment Variables
+
+Client (`client/.env`):
+
+- `EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY` (required)
+- `EXPO_PUBLIC_CONVEX_URL` (required)
+- `EXPO_PUBLIC_EAS_PROJECT_ID` (optional)
+
+Server (`server/.env`):
+
+- `CLERK_JWT_ISSUER_DOMAIN` (required in real environments)
+- `EXPO_PUSH_ENDPOINT` (optional)
+- `EXPO_ACCESS_TOKEN` (optional)
+
+## 🧪 Common Commands
 
 - `just dev`: start Expo + Convex
 - `just dev-client`: start Expo only
 - `just dev-server`: start Convex only
-- `just fmt`: run Prettier on client and server
-- `just prebuild`: generate local iOS/Android native folders
+- `just prebuild`: generate local iOS/Android folders
 - `just ios`: launch iOS app
 - `just android`: launch Android app
+- `just fmt`: format client/server
 - `just lint`: lint checks
 - `just typecheck`: TypeScript checks
 - `just test`: client + server tests
-- `just test-client`: client tests only
-- `just test-server`: server tests only
 - `just ci`: lint + typecheck + tests
 
-## 📱 Native Projects
+## 📱 Native Folder Policy
 
-Generate native projects locally when needed:
+`just prebuild` is supported for local native runs.  
+`client/ios` and `client/android` are generated locally and should not be committed.
 
-```bash
-just prebuild
-```
-
-`client/ios` and `client/android` are intentionally gitignored and should not be committed.
-
-## 🔐 Environment Variables
-
-Client (`client/.env`):
-
-- `EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY`
-- `EXPO_PUBLIC_CONVEX_URL`
-- `EXPO_PUBLIC_EAS_PROJECT_ID` (optional)
-
-Server (`server/.env`):
+## 📝 Notes
 
-- `CLERK_JWT_ISSUER_DOMAIN`
-- `EXPO_PUSH_ENDPOINT` (optional)
-- `EXPO_ACCESS_TOKEN` (optional)
+- Theme support is built-in for `light`, `dark`, and `system`.
+- Do not store sensitive auth/session tokens in MMKV.
+- Uniwind is configured via `client/global.css` and `client/metro.config.js`.
+- `SafeAreaView` is wrapped with `withUniwind` in `client/src/components/screen.tsx`.
+- `server/convex/_generated` ships with starter stubs; after connecting Convex, run `cd server && bun run codegen`.
+- `.direnv/` is gitignored by default.
 
-## 🤝 Contributor Guide
+## 🤝 Contributing
 
-Detailed implementation and maintenance notes for engineers/agents live in `AGENTS.md`.
+See `AGENTS.md` for implementation notes and project conventions.
 
-## 📝 Notes
+## 📄 License
 
-- Uniwind classes are enabled by `client/global.css` and `client/metro.config.js`.
-- `SafeAreaView` is wrapped with `withUniwind` in `client/src/components/screen.tsx` for className support.
-- `server/convex/_generated` ships with starter stubs so typecheck/tests pass before deployment setup.
-- After connecting Convex, run `cd server && bun run codegen` to regenerate server types.
-- `.direnv/` is gitignored by default.
+MIT