bobbert/MAD-Treasure-Hunt
1
0 Fork 0
mirror of https://github.com/mudabbir-ahmad/MAD-Treasure-Hunt.git synced 2026-10-08 03:00:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to simplify installation commands and clarify API endpoint usage

Browse Source
This commit is contained in:
bobbert committed 2026-04-07 00:03:58 +01:00
1 parent 8008a9b6fe
commit 60cf6baad2
1 file changed
+5 -14
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -14
View File
@@ -5,22 +5,13 @@ Treasure Hunt mobile app built with React Native and Expo.
## Run
```bash
npm install
npm run lint
expo start --android
npm i
npx expo start --android
```
## Structure
- `App.js`: app navigation entry.
- `src/components/layout`: shared screen wrapper.
- `src/components/UI`: shared UI components.
- `src/components/screens`: app screens.
- `src/hooks`: app state, API link, and feature hooks.
- `DB`: local JSON data files.
## Notes
- The app accesses game/auth data through the centralized API endpoint via `src/hooks/dbLink.js`.
- The app accesses game/auth data through the centralized API endpoint via `src/components/API/API.js`.
- Navigation is handled with React Navigation native stack.
- Sometimes you might have to switch the API Endpoint URL. This is just Because of the fact that when I'm using the app I can't access the API endpoint, from the global URL. Therefore, I need my local API Server's IP as the URL
- Just Uncomment the `API_ENDPOINT` variable in `src/components/API/API.js` to use the actual API Server Which is `api.bobby.ip-ddns.com` [Do not add any port thing here as it uses port 80 by default].