Web Documentation - 2025-11-27 [1]

coderooz · coderooz · commit ee128e0065d1 · 2025-11-27T08:54:25.000+05:30
diff --git a/.npmignore b/.npmignore
@@ -43,3 +43,4 @@ yarn-error.*
 
 # do NOT publish your dev template script
 scripts/setup.js
+docs/
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,15 @@
+title: Coderooz Expo Template
+description: A production-ready Expo starter for real business apps
+theme: jekyll-theme-primer
+markdown: GFM
+logo: /assets/logo.svg
+show_downloads: true
+google_analytics:
+nav:
+  - Home: index.md
+  - Quick Start: getting-started.md
+  - Features: features.md
+  - UI Components: ui-components.md
+  - API: api-integration.md
+  - CLI: cli-commands.md
+  - Changelog: changelog.md
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,3 @@
+- Getting Started
+  - [Introduction](/)
+  - [Installation](/guide/installation)
diff --git a/docs/api-integration.md b/docs/api-integration.md
@@ -0,0 +1,19 @@
+# API Integration Guide
+
+Use `src/lib/api.ts` as base:
+
+```ts
+export const api = {
+  get: async (url: string) => fetch(url).then(res => res.json()),
+  post: async (url: string, data: any) =>
+    fetch(url, { method: "POST", body: JSON.stringify(data) }),
+};
+````
+
+Use with hooks:
+
+```ts
+import { api } from "@/lib/api";
+
+const users = await api.get("/users");
+```
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -0,0 +1,8 @@
+:root {
+    --brand: #2563eb;
+  }
+  
+  h1, h2, h3, h4 {
+    color: var(--brand);
+    font-weight: 700;
+  }
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,4 @@
+# Changelog
+
+## 1.0.0 — Initial Release
+- First launch of Coderooz Expo Template docs
diff --git a/docs/cli-commands.md b/docs/cli-commands.md
@@ -0,0 +1,10 @@
+# CLI Commands
+
+| Command | Action |
+|--------|--------|
+| `npm start` | Run expo dev server |
+| `npm run android` | Run Android build |
+| `npx expo lint` | Check lint issues |
+| `npm version patch` | Bump version |
+
+Release workflow auto-publishes new docs.
diff --git a/docs/features.md b/docs/features.md
@@ -0,0 +1,15 @@
+# Template Features
+
+| Category | Details |
+|---------|---------|
+| UI | NativeWind, Icons System, KPIs |
+| Auth | Context & storage system |
+| Navigation | Stack + Bottom Tabs |
+| Tools | Linting + Prettier + Metro configured |
+| Productivity | Prebuilt reusable screens |
+
+----
+
+- Push Notification provider included
+- Theming via `Colors` + `Typography`
+- Expo Router-ready structure
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,31 @@
+# Quick Start
+
+## 1️⃣ Install the Template
+
+```bash
+npx create-expo-app -t expo-template-coderooz
+cd <your-app>
+npm start
+````
+
+## 2️⃣ File Structure
+
+```
+src/
+ ├─ components/
+ ├─ screens/
+ ├─ context/
+ ├─ hooks/
+ ├─ theme/
+ ├─ constants/
+ └─ lib/
+```
+
+## 3️⃣ Environment Setup
+
+* Android Studio installed
+* Expo Go OR Dev Client
+
+---
+
+➡ Explore: [Features](./features.md)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,89 @@
+# Expo Template Coderooz
+
+A powerful and modern starter template built on **Expo**, **React Native**, **NativeWind** & **TypeScript**.  
+Designed to **streamline** mobile app development with clean architecture, reusable UI components, navigation,
+state management, and strong developer experience.
+
+---
+
+## 📦 NPM Package
+
+[![npm version](https://img.shields.io/npm/v/expo-template-coderooz.svg)](https://www.npmjs.com/package/expo-template-coderooz)
+[![License](https://img.shields.io/npm/l/expo-template-coderooz.svg)](https://www.npmjs.com/package/expo-template-coderooz)
+
+🔗 **Package URL:**  
+https://www.npmjs.com/package/expo-template-coderooz
+
+---
+
+## 🚀 Quick Start
+
+```sh
+npx create-expo-app MyApp --template expo-template-coderooz
+````
+
+Or without project name (in current folder):
+
+```sh
+npx create-expo-app . --template expo-template-coderooz
+```
+
+---
+
+## ⭐ Why This Template?
+
+* 🔹 TypeScript first
+* 🔹 NativeWind (TailwindCSS for RN)
+* 🔹 Built-in tab + stack navigation
+* 🔹 Notifications + Local storage utilities
+* 🔹 Minimal + Modern UI components
+* 🔹 Scalable folder structure
+* 🔹 Ready for production
+
+---
+
+## 🧩 Package Highlights
+
+| Feature                  | Included |
+| ------------------------ | :------: |
+| Navigation               |     ✔    |
+| Authentication structure |     ✔    |
+| Async Storage helpers    |     ✔    |
+| Responsive UI Layout     |     ✔    |
+| Expo Dev Client          |     ✔    |
+| OTA Updates Ready        |     ✔    |
+
+---
+
+## 📁 Project Structure
+
+```
+src/
+ ├─ components/
+ ├─ screens/
+ ├─ constants/
+ ├─ theme/
+ ├─ hooks/
+ ├─ context/
+ └─ lib/
+```
+
+---
+
+## 📍 Links
+
+* 🔗 GitHub Repo → [https://github.com/coderooz/expo-template-coderooz](https://github.com/coderooz/expo-template-coderooz)
+* 🔗 Issue Tracker → GitHub Issues
+* 💬 Discussions → Coming soon
+
+---
+
+## ❤️ Support & Contributions
+
+Pull Requests are welcome!
+If you like this project, please ⭐ the repo!
+
+---
+
+> Built with commitment & passion by **Coderooz** 🧠⚡
+> Empowering developers with better tooling!
diff --git a/docs/ui-components.md b/docs/ui-components.md
@@ -0,0 +1,19 @@
+# UI Components
+
+This template ships with reusable UI components:
+
+| Component | Desc |
+|---------|------|
+| Header | Modern top nav bar |
+| KPI Cards | Summary stat cards |
+| Buttons | Primary + Secondary |
+
+Example:
+
+```tsx
+import Kpi from "@/components/Header";
+
+<Header />
+```
+
+*More coming soon...*

Original file line number	Diff line number	Diff line change
`@@ -43,3 +43,4 @@ yarn-error.*`
`43`	`43`
`44`	`44`	`# do NOT publish your dev template script`
`45`	`45`	`scripts/setup.js`
	`46`	`+docs/`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+- Getting Started`
	`2`	`+ - [Introduction](/)`
	`3`	`+ - [Installation](/guide/installation)`