From 1233dc4d80c7823351422a5458108525a61b0dbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastiaan?= Date: Thu, 12 Nov 2020 22:01:34 +0100 Subject: [PATCH] Add docs --- .env.example | 3 +++ README.md | 8 ++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..248062e --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +SERVER_URL = "http://localhost:8000" +OAUTH_CLIENT_ID = "clientId" +SENTRY_DSN = "https://123@o123.ingest.sentry.io/123" diff --git a/README.md b/README.md index a61d48b..5f9be6c 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,12 @@ Getting started 6. Setup the Sentry integration using `npx @sentry/wizard -i reactNative -p ios android` - To be able to do this you need access to our Sentry organisation, we use SSO with our Github organisation for this - Alternatively you can setup Sentry using the example files below. The wizard will do these steps for you. -7. Start the development server using `yarn start` -8. Deploy the app on a running emulator or connected device by running `yarn start:android` or `yarn start:ios` +7. Setup your local environment + - Create a `.env` file in the root of the repository based on `.env.example` + - Set the server and client id to those of your local concrexit installation or the staging server + - A client id can be obtained by creating an OAuth2 application in the concrexit admin +8. Start the development server using `yarn start` +9. Deploy the app on a running emulator or connected device by running `yarn start:android` or `yarn start:ios` Logging and debugging