Skip to content

starseed2021/react-native-oyster-app

Repository files navigation

Birth of Pearl - An App for Oyster Lovers

Overview

Users can search oysters by specific locations and retrieve oyster profiles.
Users also receive a random fact about oysters upon app load.
This app was written in React Native as a Capstone Project at Ada Developers Academy.

PUBLISHED APP LINK with QR CODE

Welcome. About Us. Random Fact. Regional Search. Location Search. Oyster Profile

App Features

  • Tappable Image on Welcome screen for one-touch search.
  • Swiper Component displays random oyster facts - NOTE: swiper developed for iOS but has not been optimized for Android at this time.
  • Buttons to navigate search based on region and location.
  • Random oyster fact data is sourced from an external API deployed here.

Requirements

  • Node.js - this is needed in order to access the Node Package Manager (npm).

Installation/Environment Set-Up

  • Clone this repository.
  • Install the Expo Command Line Interface by running npm install -g expo-cli.
  • Install dependencies by running npm install.
  • There are 2 very specific processes to test the app on your personal cell phone:
    • For iPhone:
      • Download Expo for iOS and set up an account.
      • Provide the owner (starseed2021) with your email in order to be given access.
      • Accept the member invitation.
      • Scan the QR Code provided in the Published App Link above.
    • For Android:
      • Download Expo for Android.
      • Scan the QR Code provided in the Published App Link above.
    • NOTE: These processes are very different because the app is still in development mode.
  • To test the app on your local machine:
    • To test on an iPhone Simulator
      • Download XCode and follow instructions.
    • To test on an Android Emulator
  • Currently, the database is small and therefore stored in a JSON file. This application is not leveraging a backend storage solution at this time.
  • To start the server run npm start or expo start. These commands are interchangeable.