From 60cf6baad25e53b2edfd7566d30799da65b91b03 Mon Sep 17 00:00:00 2001 From: mudabbir-ahmad Date: Tue, 7 Apr 2026 00:03:58 +0100 Subject: [PATCH] Update README.md to simplify installation commands and clarify API endpoint usage --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bb06c51..dee5871 100644 --- a/README.md +++ b/README.md @@ -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].