diff options
| author | Connor Justice <connorjustice@gmail.com> | 2024-02-12 11:17:26 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-12 08:17:26 -0800 |
| commit | 2ecfd106e800454213cc50d02933a63d6c08f7ee (patch) | |
| tree | 452c48d840cc1678d9c447c563c8325f92c2ccb5 /docs | |
| parent | 8253ac25d1570a21bee52d4dfa7d62ed239fc7f0 (diff) | |
| download | voidsky-2ecfd106e800454213cc50d02933a63d6c08f7ee.tar.zst | |
improves build.md completeness (#2835)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/build.md b/docs/build.md index c05e9a349..d1f9f93b5 100644 --- a/docs/build.md +++ b/docs/build.md @@ -26,11 +26,22 @@ - Start the dev servers - `git clone git@github.com:bluesky-social/atproto.git` - `cd atproto` + - `brew install pnpm` + - `brew install jq` - `pnpm i` - `pnpm build` + - Start the docker daemon (on MacOS this entails starting the Docker Desktop app) + - Launch a Postgres database on port 5432 - `cd packages/dev-env && pnpm start` - Run the dev app - iOS: `yarn ios` + - Xcode must be installed for this to run. + - A simulator must be preconfigured in Xcode settings. + - if no iOS versions are available, install the iOS runtime at `Xcode > Settings > Platforms`. + - In addition, ensure Xcode Command Line Tools are installed using `xcode-select --install`. + - Pods must be installed: + - From the project directory root: `cd ios && pod install`. + - Expo will require you to configure Xcode Signing. Follow the linked instructions. Error messages in Xcode related to the signing process can be safely ignored when installing on the iOS Simulator; Expo merely requires the profile to exist in order to install the app on the Simulator. - 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 |