Skip to content

README.md

Latest commit

 

History

History
120 lines (87 loc) · 4.09 KB

README.md

File metadata and controls

120 lines (87 loc) · 4.09 KB

📱 Food Remedy Mobile App

This is the React Native frontend for the FoodRemedy platform.
It uses Expo for fast development and cross-platform compatibility.

⚙️ Prerequisites

Make sure you have:

  • Node.js installed
  • Expo CLI: 
    npm install -g expo-cli
  • Install the Expo Go app on your iOS or Android device to preview the app via QR code.

🚀 Getting Started

  1. Navigate to the mobile-app folder 
    cd mobile-app
  2. Install Dependencies (First Time Only) 
    npm install
  3. Start the App 
    npm start

Run the App on Your Device or Simulator

It is reccomended to use your phone for best compatability. This works for both android and iOS.

⚠️ Make sure your phone is on the same Wi-Fi network if scanning QR

Choose one of the following:

  • 📱 Physical Device:
    • Scan the QR code with the Expo Go app (Android)
    • Or use your iPhone Camera app (iOS)
  • 💻 Simulators:
    • Press i to open in iOS Simulator (Mac only)
    • Press a to open in Android Emulator (if available)

Example Terminal Output

▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
█ ▄▄▄▄▄ █▄▄▄▀▀▀█▀ ▀ ▄▄▄▄▄ █
█ █   █ ██▄▀▀█▀▀▄▄█ █   █ █
█ █▄▄▄█ ██▀▄ ▄▄██▀█ █▄▄▄█ █
█▄▄▄▄▄▄▄█ ▀▄█ ▀▄▀ █▄▄▄▄▄▄▄█
█▄ █▄▄█▄██▄▀█▄▀█▀ █▄█▀█▀▀▄█
██ █▀██▄▄▄▄██▄▄▄▄▀▀███▄▀▀ █
█▀▄▄ █▄▄▄▄▄ █▀█▄ █ ▄▀▀█▀ ██
█ ▄█▀ █▄ █▀▄█▀▄▀▀▀▀▀██▄▀▀ █
█▄██▄▄█▄█ ▄  ▄▄ █ ▄▄▄  ▄▀▄█
█ ▄▄▄▄▄ █▀▀▀▀▄  █ █▄█ ███ █
█ █   █ █ ▀█▄ ▀█▄ ▄  ▄ █▀▀█
█ █▄▄▄█ █▀▄▀▀▀▀▄ ▄█▀▀▄█   █
█▄▄▄▄▄▄▄█▄██▄██▄▄▄▄█▄▄███▄█

› Metro waiting on exp://192.165.0.146:8081
› Scan the QR code above with Expo Go (Android) or the Camera app (iOS)

› Using Expo Go
› Press s │ switch to development build

› Press a │ open Android
› Press w │ open web

Logs for your project will appear below. Press Ctrl+C to exit.

Credentials

You can create a new account for the app using your own email and password.
This is handled securly by Google Firebase Authentication, and as such, no one in the project has access to your password. Only your email. Regardless, you need to manage your own security.


Environment

Expo reads public environment variables from .env:

  • EXPO_PUBLIC_API_BASE_URL — Backend base URL (e.g. http://127.0.0.1:8000)
  • EXPO_PUBLIC_API_SOURCE — backend (default via auto) or firestore to force Firestore-only data access.
  • EXPO_PUBLIC_RECOMMENDATION_SOURCE — backend (default) or firestore to switch recommendation logic.

Example .env:

EXPO_PUBLIC_API_BASE_URL=http://127.0.0.1:8000
EXPO_PUBLIC_API_SOURCE=firestore
EXPO_PUBLIC_RECOMMENDATION_SOURCE=firestore

Firestore Recommendation Mode

When EXPO_PUBLIC_RECOMMENDATION_SOURCE=firestore:

  • The app computes suitability and recommendations locally via services/recommendations.ts.
  • Candidate products are fetched from Firestore PRODUCTS using category-based queries (see services/database/products/getCandidatesForRecommendations.ts).
  • Ensure PRODUCTS documents have categories: string[] and create indexes when Firestore prompts for array-contains-any queries.

Backend mode remains available by default. The app will use server-provided alternatives from POST /scan/alternatives and only fall back to Firestore when needed.

Finished

Begin contributing to the project.
Now read: