Install and Run

Prerequisites

Since this project is using React Native, an essential requirement is Node. On Linux follow the instructions here to install Node.

Assuming you have this installed, you need to first install the Expo CLI command line utility:

npm install -g expo-cli

Follow the instructions here for more information and troubleshooting.

Installation

1. Fork the repo
2. Clone the repo:

   git clone https://github.com/ESE-Peasy/NarrateMyWay.git
   

3. Install NPM dependencies for the project:

   cd app
   npm install
   

4. Install various dependencies for your OS system and Android/iOS here

Linux android setup

Following steps from here

Install Android studio via snap:

sudo snap install android-studio --classic

To get the correct Java version:

sudo apt install default-jdk

Running the Application

1. To run the application you can navigate to the app directory and execute npm start:

    cd app
    npx react-native start
   

Running on Android

1. Start an emulator via Android studio or connect your Android phone to your computer via USB. Ensure developer mode and usb debugging is turned on. Follow here for more instructions

2. Check the relvant USB device is accessible

   adb devices
   

3. Build the android app

   npm run android
   

Running on iOS

1. To run on an emulator

   npx react-native run-ios --simulator="iphone 11" 
   

   (change name to match intended iPhone model)

2. To run on an iPhone, follow instructions here