Skip to content

Commit 5ec692e

Browse files
authored
Revise features and add stack summary in README
Updated features section and added stack summary.
1 parent d8877a7 commit 5ec692e

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -60,31 +60,33 @@ Prerequisites: [Getting Started](#getting-started)
6060

6161
---
6262

63-
## ✨ Features
64-
65-
Pinned versions live in [`package.json`](package.json). This is the at-a-glance stack summary.
66-
67-
| Category | Library | Description |
68-
| ----------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
69-
| **Framework** | react-native | Bare workflow, TypeScript, Hermes engine |
70-
| **Theme** || Light & Dark via `ThemeProvider`; semantic tokens; `useTheme()` |
71-
| **Navigation** | @react-navigation | Native stacks, Bottom Tabs, Modals |
72-
| **i18n** | i18next + react-i18next | Flat JSON per locale, feature-keyed sections, type-safe `useT()` |
73-
| **Validation** | zod | Schema validation on API responses; typed domain mappers |
74-
| **HTTP** | apisauce | Centralized instance with auth, error, and logging interceptors |
75-
| **Transport** || Pluggable adapters: REST (Axios), GraphQL, WebSocket, Firebase |
76-
| **Server State** | @tanstack/react-query | Query/mutation management with persistence and tag-based invalidation |
77-
| **Offline** || NetInfo → transport offline mode; mutation queue + replay; Query cache + MMKV — [OFFLINE.md](docs/OFFLINE.md) |
78-
| **Storage** | react-native-mmkv + react-native-nitro-modules | Fast key-value storage; **keep versions paired** — [development.md § MMKV / Nitro](docs/development.md#react-native-mmkv-and-react-native-nitro-modules) |
79-
| **Lists** | @shopify/flash-list | High-performance virtualized lists |
80-
| **SVG** | react-native-svg | Icons via `npm run gen:icons` |
81-
| **Splash Screen** | react-native-bootsplash | `npm run bootsplash:generate` — [development.md](docs/development.md#key-commands) |
82-
| **Native Utils** || Device info, haptics, runtime permissions |
83-
| **Biome** | @biomejs/biome | Format, lint, import organization (`biome check`) |
84-
| **Monitoring** | @sentry/react-native | Optional when `SENTRY_DSN` is set — [OPERATIONS.md#sentry](docs/OPERATIONS.md#sentry) |
85-
| **CI/CD** | GitHub Actions | Quality checks + manual native builds — [OPERATIONS.md#github-actions](docs/OPERATIONS.md#github-actions) |
63+
## ✨ Core Features
8664

87-
---
65+
| Capability | Included | Why it matters |
66+
|---|---|---|
67+
| **Bare React Native** | Full native control and long-term flexibility |
68+
| **React Navigation** | Real app navigation with stacks, tabs, and modals already wired |
69+
| **Server state** | `@tanstack/react-query` with persistence and tag-based invalidation | Clean API data flow, cache control, retries, and better async handling |
70+
| **Global state** | `zustand` | Lightweight shared state without Redux boilerplate |
71+
| **Fast local storage** | `react-native-mmkv` + `react-native-nitro-modules` | Blazing-fast persisted storage; positioned as up to **30× faster than AsyncStorage** |
72+
| **Offline-ready flow** | Queue, replay, and cache persistence for unstable networks |
73+
| **Transport layer** | Pluggable adapters for REST, GraphQL, WebSocket, Firebase | Swap backend strategy without rewriting the whole app foundation |
74+
| **Theme system** | Light/Dark mode with semantic tokens and `useTheme()` | Consistent styling without magic values spread everywhere |
75+
| **Localization** | `i18next` + `react-i18next` + typed `useT()` | Real i18n support from day one, not bolted on later |
76+
| **SVG icon script** | Easier icon pipeline with `npm run gen:icons` |
77+
| **BootSplash included** | Native splash setup is already there |
78+
- **Modern quality gates** with Biome, Jest, GitHub Actions, and Maestro smoke flows
79+
80+
81+
### 📦 Stack summary
82+
83+
Pinned versions live in [`package.json`](package.json).
84+
85+
For deeper implementation details, see:
86+
87+
- [docs/development.md](docs/development.md)
88+
- [docs/OFFLINE.md](docs/OFFLINE.md)
89+
- [docs/OPERATIONS.md](docs/OPERATIONS.md)
8890
8991
## 🧭 Project structure
9092

0 commit comments

Comments
 (0)