Skip to content

Commit 694788a

Browse files
authored
Update README.md
1 parent 5dc5c2d commit 694788a

File tree

1 file changed

+55
-49
lines changed

1 file changed

+55
-49
lines changed

README.md

Lines changed: 55 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
````md
12
# React Native Bare Starter
23

34
[![Use this template](https://img.shields.io/badge/Use%20this%20template-2ea44f?logo=github&logoColor=white)](https://github.com/maximcoding/react-native-starter/generate)
@@ -8,9 +9,10 @@
89

910
A bare React Native starter for serious apps — no Expo, fast storage, modern state management, and a production-minded foundation from day one.
1011

11-
----------
12+
---
1213

1314
## ✨ Features Included
15+
1416
- **🧱 Bare React Native 0.82.1** — full native control, no Expo lock-in
1517
- **🧭 React Navigation 7.x** — stacks, tabs, and modals already wired
1618
- **📦 TanStack Query 5.x** — server-state, caching, retries, invalidation, and persistence
@@ -23,21 +25,22 @@ A bare React Native starter for serious apps — no Expo, fast storage, modern s
2325
- **🖼️ SVG via script**`react-native-svg 15.x` with scripted icon generation
2426
- **🚀 BootSplash 6.x** — native splash screen setup already in place
2527
- **🧪 Developer experience** — Biome 2.x, Jest 29.x, GitHub Actions CI, and Maestro E2E
28+
- **AI / agent workflow docs** — includes `.claude` agents and repo rules for more consistent AI-assisted changes
2629

27-
-----
30+
---
2831

2932
## 🛠️ Getting started
3033

3134
### Prerequisites
3235

3336
Standard bare React Native toolchain:
3437

35-
- Node.js ≥ 20
36-
- Xcode for iOS
37-
- Android Studio + SDK for Android
38-
- CocoaPods for iOS
38+
- Node.js ≥ 20
39+
- Xcode for iOS
40+
- Android Studio + SDK for Android
41+
- CocoaPods for iOS
3942

40-
-----
43+
---
4144

4245
## 🚀 Quick Start
4346

@@ -47,17 +50,18 @@ cd react-native-starter
4750
npm install
4851
npx pod-install ios
4952
cp .env.example .env
50-
```
53+
````
5154

5255
Edit `.env` as needed, then:
5356

5457
```bash
5558
npm start # Metro bundler
5659
npm run ios # or: npm run android
5760
```
58-
-----
5961

60-
## 🧭 Project structure
62+
---
63+
64+
## 🧭 Project structure
6165

6266
Feature-first structure with clear boundaries.
6367

@@ -80,15 +84,17 @@ assets/
8084
├── svgs/ # Source SVGs
8185
├── bootsplash/ # Generated splash assets
8286
└── icons.ts # Auto-generated icon registry
87+
```
8388

84-
- **Repository layout** → [docs/development.md#repository-layout](docs/development.md#repository-layout)
85-
- **Code rules & ownership** → [AGENTS.md](AGENTS.md)
89+
* **Repository layout** → [docs/development.md#repository-layout](docs/development.md#repository-layout)
90+
* **Code rules & ownership** → [AGENTS.md](AGENTS.md)
8691

87-
-----
92+
---
8893

8994
## 🔐 Environment variables
90-
Values are read at build time via react-native-config.
91-
See .env.example. Rebuild the app after changing .env.
95+
96+
Values are read at build time via `react-native-config`.
97+
See [`.env.example`](.env.example). Rebuild the app after changing `.env`.
9298

9399
| Variable | Required | Purpose |
94100
| ------------------------------------------- | ------------ | ----------------------------------------------------- |
@@ -103,71 +109,71 @@ See .env.example. Rebuild the app after changing .env.
103109

104110
Useful docs:
105111

106-
Sentry setup
107-
OTA / updates policy
108-
Publishing / discoverability
112+
* [Sentry setup](docs/OPERATIONS.md#sentry)
113+
* [OTA / updates policy](docs/OPERATIONS.md#over-the-air-updates)
114+
* [Publishing / discoverability](docs/OPERATIONS.md#publishing--discoverability)
109115

110-
-----
116+
---
111117

112118
## ⌨️ Key Commands
113119

114-
| Command | What it does |
115-
|---|---|
116-
| `npm start` | Start Metro (cache reset) |
117-
| `npm run ios` / `npm run android` | Run on simulator or device |
118-
| `npm run lint` | Biome check (read-only) |
119-
| `npm run format` | Biome format + safe fixes |
120-
| `npm test` | Jest |
121-
| `npx tsc --noEmit` | Typecheck |
122-
| `npm run i18n:all` | Extract i18n keys + generate types |
123-
| `npm run gen:icons` | Regenerate SVG icon registry |
124-
| `npm run android:clean` | Clean Android build artifacts |
120+
| Command | What it does |
121+
| --------------------------------- | ---------------------------------- |
122+
| `npm start` | Start Metro (cache reset) |
123+
| `npm run ios` / `npm run android` | Run on simulator or device |
124+
| `npm run lint` | Biome check (read-only) |
125+
| `npm run format` | Biome format + safe fixes |
126+
| `npm test` | Jest |
127+
| `npx tsc --noEmit` | Typecheck |
128+
| `npm run i18n:all` | Extract i18n keys + generate types |
129+
| `npm run gen:icons` | Regenerate SVG icon registry |
130+
| `npm run android:clean` | Clean Android build artifacts |
125131

126132
Full command reference: [docs/development.md#key-commands](docs/development.md#key-commands)
127133

128-
-----
134+
---
129135

130136
## 🛠️ Android Troubleshooting
131137

132-
- **No connected devices** — start an emulator or connect via USB, then `npm run android:devices`
133-
- **CMake / missing `codegen/jni`** — run `npm run android:clean`, then `npm run android`
134-
- **Still failing** — `rm -rf node_modules/*/android/build`, reinstall, rebuild
135-
- **Gradle clean without broken native tasks** — `npm run android:clean:gradle`
138+
* **No connected devices** — start an emulator or connect via USB, then `npm run android:devices`
139+
* **CMake / missing `codegen/jni`** — run `npm run android:clean`, then `npm run android`
140+
* **Still failing**`rm -rf node_modules/*/android/build`, reinstall, rebuild
141+
* **Gradle clean without broken native tasks**`npm run android:clean:gradle`
136142

137143
Full detail: [docs/development.md#android-build](docs/development.md#android-build)
138144

139-
-----
145+
---
140146

141147
## 🔐 Permissions
142148

143149
Declare only what you actually use. Full catalog: [docs/permissions-bare-rn.md](docs/permissions-bare-rn.md)
144150

145-
----------
151+
---
146152

147153
## 📚 Documentation
148154

149-
| Topic | Location |
150-
|---|---|
151-
| Rules, structure & contribution flow | [AGENTS.md](AGENTS.md) |
152-
| Developer reference | [docs/development.md](docs/development.md) |
153-
| Offline behavior | [docs/OFFLINE.md](docs/OFFLINE.md) |
154-
| Operations, CI, releases, Sentry | [docs/OPERATIONS.md](docs/OPERATIONS.md) |
155-
| Permissions catalog | [docs/permissions-bare-rn.md](docs/permissions-bare-rn.md) |
156-
| Roadmap | [docs/TODO.md](docs/TODO.md) |
157-
| Changelog | [CHANGELOG.md](CHANGELOG.md) |
155+
| Topic | Location |
156+
| ------------------------------------ | ---------------------------------------------------------- |
157+
| Rules, structure & contribution flow | [AGENTS.md](AGENTS.md) |
158+
| Developer reference | [docs/development.md](docs/development.md) |
159+
| Offline behavior | [docs/OFFLINE.md](docs/OFFLINE.md) |
160+
| Operations, CI, releases, Sentry | [docs/OPERATIONS.md](docs/OPERATIONS.md) |
161+
| Permissions catalog | [docs/permissions-bare-rn.md](docs/permissions-bare-rn.md) |
162+
| Roadmap | [docs/TODO.md](docs/TODO.md) |
163+
| Changelog | [CHANGELOG.md](CHANGELOG.md) |
158164

159-
----------
165+
---
160166

161167
## 🤝 Contributing
162168

163169
Contributions welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) for branch/PR rules, quality checks, and PR checklist.
164170

165-
----------
171+
---
166172

167173
## 🚢 CI/CD & Release
168174

169175
GitHub Actions, local release builds, store secrets, Sentry, Maestro, OTA policy, and publishing notes: [docs/OPERATIONS.md](docs/OPERATIONS.md)
170176

171177
Version history: [CHANGELOG.md](CHANGELOG.md)
172178

173-
-----
179+
```

0 commit comments

Comments
 (0)