Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(mobile): update getting started steps #4967

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs(mobile): update getting started steps #4967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apps/mobile/.env.development
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Environment: development

APP_VARIANT=production
GOOGLE_SERVICES_PLIST_DEV=./GoogleService-Info.plist
GOOGLE_SERVICES_JSON=./google-services.json
GOOGLE_SERVICES_PLIST=./GoogleService-Info.plist
24 changes: 21 additions & 3 deletions apps/mobile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Safe{Wallet} mobile app 📱

This project is now part of the **@safe-global/safe-wallet** monorepo! The monorepo setup allows centralized management of multiple
This project is now part of the **@safe-global/safe-wallet** monorepo! The monorepo setup allows centralized management
of multiple
applications and shared libraries. This workspace (`apps/mobile`) contains the Safe Mobile App.

You can run commands for this workspace in two ways:
Expand All @@ -16,7 +17,8 @@ In the addition to the monorepo prerequisites, the mobile app requires the follo
- iOS/Android Development Tools
- [Maestro](https://maestro.mobile.dev/) if you want to run E2E tests

You can follow the [expo documentation](https://docs.expo.dev/get-started/set-up-your-environment/) to install the CLI and set up your development environment.
You can follow the [expo documentation](https://docs.expo.dev/get-started/set-up-your-environment/) to install the CLI
and set up your development environment.

Follow the [Maestro](https://maestro.mobile.dev/) documentation to install the tool for E2E testing.

Expand All @@ -30,6 +32,21 @@ yarn install

## Running the app

There is a .env.development file in the root of the mobile app that contains the following environment variables:

```bash
APP_VARIANT=production
GOOGLE_SERVICES_PLIST_DEV=./GoogleService-Info.plist
GOOGLE_SERVICES_JSON=./google-services.json
GOOGLE_SERVICES_PLIST=./GoogleService-Info.plist
```

When any expo command runs it will automatically load the `.env.development` file. If you want to make modifications
to the environment variables, you can create a `.env.local` file in the root of the mobile app.

For local development you need to place the `google-services.json` and `GoogleService-Info.plist` files in the root of
the mobile app.

### Running on iOS

From the root of the monorepo:
Expand All @@ -46,7 +63,8 @@ yarn start:ios

> [!NOTE]
>
> From now on for brevity we will only show the command to run from the root of the monorepo. You can always run the command from the `apps/mobile` directory you just need to omit the `workspace @safe-global/mobile`.
> From now on for brevity we will only show the command to run from the root of the monorepo. You can always run the
> command from the `apps/mobile` directory you just need to omit the `workspace @safe-global/mobile`.

### Running on Android

Expand Down
Loading