tabbiho / foragr-frontend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

foRAg'r

logo

foRAg'r is a mobile app that helps user keep track of food items in their fridge. Features include parsing receipt, searching food by keywords and sending notifications when food is near expiry.

The app is best viewed on iPhone or Android devices.

Note: This is the frontend repo. The backend repo can be viewed here.

Walkthrough

1. User login

Informative login page with a preview of features available

login screen gif login with OAuth gif

2. Home page

An overview of food items present in user's fridge

home page

3. Camera Mode

User can choose to take photo of receipt/upload photo of receipt to automatically add food items to fridge

OCR with camera gif OCR with existing image gif

4. Manual entry Mode

Users can search food items by keywords

manual entry image

5. Review mode

Users can search food items by keywords

review items gif

6. Notifcation

When food is near expiry, native notifications will appear even when phone screen is locked

notification image

Built with

Tech Purpose
Frontend React Native User interface
Expo React Native framework
NativeBase Component library
Lottie Animated loaders
Backend Node.js Server
Express Server
PostgreSQL Database
Sequelize Database
Functionality JWT Authentication

ERD

library

Installation

The backend is already hosted on Heroku and no setup is necessary. However, there are frontend environment variables that are not tracked in this repo. Please contact the developers if you would like to run this project locally on your machine. We will also require an email address that's tied to your Google Account in order to set up the OAuth Login for you.

Requirements

  1. npm: npm install npm@latest -g
  2. Expo Go: Install Expo Go on your mobile device from the App Store ('Expo') or Play Store ('Expo Go').

To run the app

  1. Clone this repo
  2. Install dependencies: npm i
  3. The devs will share a secret file with you; save this to the main folder
  4. Run the app: expo start
  5. Scan the generated QR code with your phone to view the app on your mobile device

Contributors

Cheena Eng | GitHubLinkedInEmail

Elizabeth Tan | GitHubLinkedInEmail

Gerald Khor | GitHubLinkedInEmail

Tabithan Ho | GitHubLinkedInEmail

About


Languages

Language:JavaScript 100.0%