about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAnsh <anshnanda10@gmail.com>2023-05-16 11:14:02 -0700
committerGitHub <noreply@github.com>2023-05-16 13:14:02 -0500
commitd5bec4ff37fb3423b8f083dd9fe95c066b4cf90e (patch)
tree8b6fe79e293d3afee7195ab0975feec8a82b9e40 /docs
parent50c1841a06d0502428f70bb0bb225cca70f82c20 (diff)
downloadvoidsky-d5bec4ff37fb3423b8f083dd9fe95c066b4cf90e.tar.zst
Update build instructions (#639)
* Create .env.example

* Update build.md

* Update eas.json

* Update build.md

* Update build.md

* Update build.md

* Update docs/build.md

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>

---------

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>
Diffstat (limited to 'docs')
-rw-r--r--docs/build.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/build.md b/docs/build.md
index efe249766..3fc3b123a 100644
--- a/docs/build.md
+++ b/docs/build.md
@@ -18,6 +18,7 @@
   - iOS: `yarn ios`
   - Android: `yarn android`
   - Web: `yarn web`
+- If you are cloning or forking this repo as an open source developer, please check the tips below as well
 - Run e2e tests
   - Start in various console tabs:
     - `yarn e2e:server`
@@ -25,6 +26,8 @@
   - Run once: `yarn e2e:build`
   - Each test run: `yarn e2e:run`
 - Tips
+  - Make sure you copy the `.env.example` to `.env` and add the appropiate tokens (e.g. `SENTRY_AUTH_TOKEN` can be created on the Sentry dashboard). If this is not required, you can remove it from `eas.json` and `package.json`, as well as any mentions in the code.
+  - If you want to use Expo EAS on your own builds without ejecting from Expo, make sure to change the `owner` as well as `extra.eas.projectId` properties. If you do not have an Expo account, you may remove these properties.
   - `npx react-native info` Checks what has been installed.
   - The android simulator won't be able to access localhost services unless you run `adb reverse tcp:{PORT} tcp:{PORT}`
     - For instance, the localhosted dev-wallet will need `adb reverse tcp:3001 tcp:3001`