zura-stack-native/README.md

A comprehensive React Native CLI project generator with production-ready setup

# ZuraStackNative CLI

A modern, production-ready React Native project generator for teams and solo developers who want to start fast with best practices, scalable folder structure, and all essential tools pre-configured.

---

## Why ZuraStackNative?

Setting up a robust React Native app from scratch is time-consuming and error-prone. ZuraStackNative automates the process, giving you:

- **React Native CLI (not Expo)** with TypeScript, ready for production
- **NativeWind** (Tailwind CSS for React Native) and **Gluestack UI** for beautiful, scalable UI
- **Zustand** for state management
- **React Navigation** with Home/Profile screens out of the box
- **Lucide React Native** icons, correctly integrated
- **Industry-grade folder structure** for real-world projects
- **Manual/interactive CLI steps** for Gluestack UI to avoid config issues
- **No bloat, no opinionated theming**—just the essentials, set up right

---

## Features

- 🚀 React Native 0.80.1 + TypeScript
- 🎨 NativeWind & Gluestack UI (with correct install order)
- 🧭 React Navigation (with Home/Profile screens)
- 🐿️ Zustand state management
- 🗂️ Scalable, industry-grade folder structure
- 🦄 Lucide React Native icons
- ⚡ Fast, reliable CLI (built with Commander, Inquirer, Chalk, Ora)

---

## Quick Start

```sh
# Install globally
npm install -g zura-stack-native

# Create a new project (interactive prompts for Gluestack UI)
zura-stack-native create MyApp

# Or use with npx (no global install required)
npx zura-stack-native create MyApp
```

---

## What You Get

- **src/** with all folders for api, components, features, hooks, navigation, screens, store, theme, types, utils, etc.
- **App.tsx** in src/ with navigation and providers set up
- **HomeScreen**: Modern, responsive grid UI using NativeWind, Gluestack UI, and Lucide icons
- **ProfileScreen**: Clean, themed profile page
- **All configs** (babel, metro, tailwind, etc.) ready for NativeWind & Gluestack UI
- **No Expo, no unnecessary dependencies**

---

## Usage

- Run the CLI and follow the prompts (especially for Gluestack UI, which requires manual input)
- Your project is ready to run: `cd MyApp && npm start`
- For iOS: `npm run ios`  |  For Android: `npm run android`

---

## Contributing

PRs welcome! Please open issues for bugs or feature requests.

---

## License

MIT