Adds some installation instructions

This commit is contained in:
Aaron Louie 2020-08-28 23:53:47 -04:00
parent 8a167f77d5
commit 03e8ea921e
1 changed files with 18 additions and 0 deletions

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# UVA COVID-19 Testing Kiosk App
## Development
1. Install prerequisites:
* [node & npm](https://nodejs.org/en/download/)
* [react-native & expo-cli](https://docs.expo.io/get-started/installation/)
* [Expo Client app on your Android/iOS device](https://expo.io/tools)
2. Clone this repository.
3. In your terminal, navigate to the repository and run `npm install` to install all the necessary dependencies and libraries.
4. Start the expo development server: `expo start -c`
5. A browser window should open, displaying a QR Code. Using your mobile device, scan the QR Code, which will prompt you to open the Expo Client app.
## Deployment
TBD - Coming soon...
* Windows
* MacOS
* iOS
* Android