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

Commit 4b97eeb

Browse files
committed
feat: add installation instructions and update tech stack in README
1 parent d66602c commit 4b97eeb

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🎁 Gift Idea Tracker
1+
b# 🎁 Gift Idea Tracker
22

33
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.
44

@@ -17,7 +17,7 @@ We leveraged **cutting-edge AI tools** throughout the entire software developmen
1717
| 💻 Development | [a0.dev](https://a0.dev) to generate boilerplate code from designs<br>[VSCode](https://code.visualstudio.com) with [GitHub Copilot](https://github.com/features/copilot) for live coding, bug fixes, and code suggestions |
1818
| 🧪 Testing | Combination of **GitHub Copilot** and **ChatGPT** for writing test cases and debugging<br>Manual & automated testing via Jest + React Native Testing Library |
1919

20-
<br>
20+
<br/>
2121

2222
## ✨ Features
2323

@@ -30,8 +30,7 @@ We leveraged **cutting-edge AI tools** throughout the entire software developmen
3030
- 🔔 Push notifications (optional)
3131
- ☁️ Data stored securely using Supabase
3232

33-
34-
<br>
33+
<br/>
3534

3635
## 🛠️ Tech Stack
3736

@@ -43,3 +42,28 @@ We leveraged **cutting-edge AI tools** throughout the entire software developmen
4342
| AI Assistant | ChatGPT, GitHub Copilot, a0.dev |
4443
| Testing | Jest, React Native Testing Library, Detox |
4544
| Build/Deploy | Expo, EAS Build, Google Play, TestFlight |
45+
46+
<br/>
47+
48+
## 🧩 Installation & Running App
49+
50+
- Clone the repository:
51+
```bash
52+
git clone https://github.com/your-username/gift-idea-tracker.git
53+
cd gift-idea-tracker
54+
```
55+
56+
- Install dependencies using Bun:
57+
```bash
58+
bun install
59+
```
60+
61+
- Start Expo development server
62+
```bash
63+
bun run start
64+
```
65+
66+
- Run unit and integration tests
67+
```bash
68+
bun x jest
69+
```

0 commit comments

Comments
 (0)