Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 0fd5bc7

Browse files
committed
update: add initial README with project overview, features, tech stack, testing strategy, and deployment details
1 parent 67c6b9c commit 0fd5bc7

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# 🎁 Gift Idea Tracker
2+
3+
A mobile application built with **React Native + Redux + Supabase**, designed to help users organize and track gift ideas for their friends, family, and special occasions — all in one place.
4+
5+
> 📆 Plan ahead. 🎁 Stay thoughtful. 💡 Never forget a gift again.
6+
7+
---
8+
9+
## ✨ Features
10+
11+
- 🧠 AI-assisted wireframes for fast UI prototyping
12+
- 📋 Manage gift ideas with title, image, notes, and tags
13+
- 👥 Add & manage recipients and event dates
14+
- 💰 Track budgets for each recipient and overall spending
15+
- 📊 Visual charts for budget analysis
16+
- ⏰ Reminder & calendar sync for upcoming events
17+
- 🔔 Push notifications (optional)
18+
- ☁️ Data stored securely using Supabase
19+
20+
---
21+
<!--
22+
## 📱 Screenshots
23+
24+
| Home Screen | Budget Overview | Add Gift Idea |
25+
|-------------|------------------|----------------|
26+
| ![Home](screenshots/home.png) | ![Budget](screenshots/budget.png) | ![Add](screenshots/add.png) | -->
27+
28+
---
29+
30+
## 🛠️ Tech Stack
31+
32+
| Layer | Tools/Tech |
33+
|--------------|----------------------------------------------|
34+
| Frontend | React Native, Redux Toolkit, TypeScript |
35+
| Backend | Supabase (PostgreSQL, Auth, Storage) |
36+
| Design | Figma, Uizard |
37+
| Testing | Jest, React Native Testing Library, Detox |
38+
| Build/Deploy | Expo, EAS Build, Google Play, TestFlight |
39+
40+
---
41+
42+
## 🧪 Testing Strategy
43+
44+
| Test Type | Description |
45+
|---------------|-----------------------------------------------------------------------------|
46+
| Unit Test | Validate functions, reducers, small components (e.g., `NoteCard`, `noteSlice`) |
47+
| Integration | Test flow across Redux + UI + Service (e.g., add/delete note flows) |
48+
| UI Test | Ensure components render correctly with given state |
49+
| E2E Test | Simulate real user interactions via Detox |
50+
| API/Service | Mock Supabase API calls and validate service logic |
51+
52+
📦 Full testing report included in `/__tests__` folder.
53+
54+
---
55+
56+
## 🚀 Deployment
57+
58+
- Built and deployed via **EAS Build** (Expo Application Services)
59+
- Internal Testing with **Expo Go**
60+
- ✅ Android `.apk` ready for distribution
61+
- ✅ iOS `.ipa` tested via TestFlight
62+
63+
### Deployment Tools
64+
65+
- Expo CLI / EAS CLI
66+
- Google Play Console
67+
- Apple Developer Console
68+
- OTA updates with `eas update`

0 commit comments

Comments
 (0)