STEVE is the iOS & Android app our team of five developed for our final-year Capstone Industry Project and was developed in consulation with our Industry Client, Planit Testing.
Please feel free to read the supplied documentation in the 'DOCUMENTATION' folder in the main branch, and review the code at your leisure.
Note: For a complete installation guide with image-based step-by-step instructions please refer to the installation guide in the submitted User Manual. This README guide is largely based off those instructions, and will try to get you up and running as quickly as possible. Both guides assume the user either wants to install the app on their Android device, or is using Windows 10 and wants to set up the development environment with Android Studio.
- Transfer the supplied .apk file to your Android device
- Install the .apk file
- Open the newly installed 'STEVE' app
- You must have been supplied with the 'accessKeyId' and 'secretAccessKey' for the 'amplify-user' user
- You must have been supplied with the 'aws-exports.js' file
- In your browser, navigate to https://nodejs.org/en
- Download the most recent LTS build and install node.js. Just accept the installation defaults on every screen by clicking 'Next', then finally 'Install' and 'Finish'
- Run the following command in Command Prompt:
curl -sL https://aws-amplify.github.io/amplify-cli/install-win -o install.cmd && install.cmd
- Run the following command in Command Prompt:
amplify configure
- The Command Prompt will ask you to 'Sign in to your AWS administrator account' and will open a browser window. Please ignore this, close the browser window, and press Enter in the Command Prompt to continue.
- You will be asked to ‘Specify the AWS Region’. Use the Up and Down arrow keys to navigate to ‘ap-southeast-2' and make sure it is highlighted in blue before pressing Enter to confirm the region
- You will be asked to ‘Specify the username of the IAM user'. Please enter:
amplify-user
- The Command Prompt will ask you to ‘Complete the user creation using the AWS console’ and will open a browser windows. Please ignore this, close the browser window, and press Enter in the Command Prompt to continue.
- You will now be asked to enter the access key of the newly created user. For the ‘accessKeyId’, please enter the supplied 'accessKeyId' for amplify-user
- When it asks you to enter the 'secretAccessKey', please enter the supplied secretAccessKey for amplify-user
- When it asks for a ‘Profile Name’, simply press Enter to select the default profile
- Installation of the AWS Amplify CLI is now complete
- In your browser, sign in to the same GitHub account where you have access to the Team Freeware STEVE repository. Then navigate to https://github.com/jamesworcester/STEVE and click on the green button that says ‘Code’, then click on ‘Download ZIP’
- Once the file has downloed, Extract it
- Copy the path of the newly extracted folder where you can see a bunch of different directories and files
- In Command Prompt, cd into that directory
- In Command Prompt, run:
npm install
- Copy the supplied 'aws-exports.js' file into 'STEVE-main\src'
- Navigate to https://developer.android.com/studio and download Android Studio
- Accept all the terms and just accept the defaults on every screen by clicking 'Next', 'Install' and 'Finish', after which Android Studio should start
- In Android Studio, select 'Do not import settings' and click 'OK'
- Just keep clicking 'Next' on all the screens, accept the license agreements and click 'Finish' and wait for the download to complete and click 'Finish'
- On the 'Welcome to Android Studio' screen, click on the blue text that says 'More Actions' to open a dropdown menu, then click on 'Virtual Device Manager'
- Click on 'Create device'
- Select 'Pixel 5' and click on 'Next'
- Under 'Release Name', click on the Download icon next to 'S' and wait for the download to finish
- Once the download has completed, click on 'Finish'
- When selecting a System Image, highlight the one with release name 'S' and press 'Next'
- Click on 'Show Advanced Settings'
- Scroll down to where it says 'Memory and Storage' and set the 'Internal Storage' to 2000 MB and press 'Finish'
- For the new Pixel 5 emulated device you created, click on the white Play buton that looks like a triangle and wait for the emulated Pixel 5 device to boot up
- Once the device has booted up, open a Command Prompt, cd into the STEVE-main directory and run:
npx expo start
and press Enter to install the Expo CLI globally
-
Once the Expo CLI has been installed and started, you should see a screen in the Command Prompt with a QR code and some instructions. Press 'a' in the Command Prompt to begin installing the Expo Go app on your emulated device
-
Once Expo has installed, the JavaScript code for the STEVE app will be bundled and sent to the emulated device, and you should now see the login screeen for the app
-
Remember each session that when first signing into the app or creating an account, please allow 40-50 seconds between your first attempt and your second to allow the database compute functions to spin up. Once spun up, the database will only spin down again once it has been 20 minutes since the last API/SQL request.
- When you're done with the device, you may power it down the same way you would an actual android phone, and you can close the Command Prompt window
- If you ever want to open the app up again, first start your emulated Pixel 5 Android device in Android Studio, then open a Command Prompt, cd into the 'STEVE-main' directory and run:
expo start
- Once the Expo CLI has started, press 'a' to launch the app in the Android Emulator