diff --git a/README.md b/README.md new file mode 100644 index 0000000..00034e4 --- /dev/null +++ b/README.md @@ -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