diff --git a/README.md b/README.md index f96712c..6c4f9e5 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,48 @@ This project contains the components developed for a mobile app within the Water $ cd WPD-MobileApp/src $ npm run test + + +## Run the app + +To run the app locally, you need to install the [Expo Go](https://expo.io/client) app on your mobile device and then scan the QR code that appears in the terminal after running the following command: + +Ensure you have Yarn installed globally: + + $ # on macOS + $ sudo yarn install + $ + $ # on Linux + $ sudo apt update && sudo apt install yarn + +Via Yarn, you can Expo CLI globally: + + $ sudo yarn global add expo-cli + $ + $ # It is possible that some extensions are needed + $ sudo yarn add expo-build-properties + +Using Expo you can configure the app to run on a mobile OS. In this case Android: + + $ eas build:configure + + +## Run on Android Emulator + +To run the app using expoon an Android emulator, you need to install the [Android Studio](https://developer.android.com/studio) and then run the following command: + + $ cd WPD-MobileApp/src + $ npm run android + + +## Build and publish the app + +To build and publish the Android app, you have to run the following commands: + + $ eas build -p android + +This uses the EAS Build service to build the app. You can check the status of the build in the [EAS Build dashboard](https://expo.io/dashboard/builds). + +Note that you might be asked to provide your Expo credentials. If you don't have an Expo account, you can create one by running the following command: + + $ expo register diff --git a/src/app.json b/src/app.json index 6b17cf5..d73a027 100644 --- a/src/app.json +++ b/src/app.json @@ -24,13 +24,12 @@ } }, "android": { - "permissions": ["com.google.android.gms.permission.AD_ID"], "adaptiveIcon": { "foregroundImage": "./app/assets/appLogo.png", "backgroundColor": "#FFFFFF" }, "package": "com.dadosaprovadagua.wpdmobileapp", - "versionCode": 9 + "versionCode": 11 }, "web": { "favicon": "./app/assets/favicon.png"