Skip to content

Improve hybrid app docs a bit #58003

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

Merged
cristipaval merged 2 commits into from
Mar 7, 2025
Merged

Improve hybrid app docs a bit #58003

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fa37ae
Improve docs a bit
Beamanator Mar 7, 2025
22e01ae
Merge branch 'main' of github.com:Expensify/App into beaman-improveHy…
Beamanator Mar 7, 2025
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
8 changes: 5 additions & 3 deletions contributingGuides/HYBRID_APP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The build should be very straightforward. Assuming you've cleared cache, and hav
1. `npm i`
2. `npm run pod-install` (if you build iOS)
3. `npm run ios` or `npm run android`
If you encounter any problems, please refer to the [[#Pro Tips & Troubleshooting]] section, or (if you don't find your answer there) remove the cache by executing `npm run clean`
If you encounter any problems, please refer to the [[Pro Tips & Troubleshooting](#pro-tips-and-troubleshooting)] section, or (if you don't find your answer there) remove the cache by executing `npm run clean`

@Beamanator Beamanator Mar 7, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we wanted this to be a link, and now it's linkable!


# Submodules
OldDot code in `Expensify/App` repo is located in `Mobile-Expensify` directory, which technically is a git submodule. Even though it seems like an advanced concept, in reality it is very straightforward: it basically sets a commit hash from which `Mobile-Expensify` code should be pulled.
Expand All @@ -75,7 +75,7 @@ In practice a submodule is just a regular git repository, set to a specific comm
If you change the `Mobile-Expensify` code, it will be seen by `Expensify/App` as a commit hash change that may be pushed to a remote repository. Currently we automatically update the `Mobile-Expensify` commit hash, therefore you don't need to do it manually. In order to avoid confusion you can update your `.git/config` by running the following command: `git config submodule.Mobile-Expensify.ignore all`. This way you won't accidentally change the commit hash for the submodule in your PR.
## Useful commands

IMPORTANT: Please execute the following commands form the root of the project!
IMPORTANT: Please execute the following commands from the root of the project!
- `git submodule update --init`
- it initialises the submodule, and pulls the `Mobile-Expensify` code from the commit set in `Expensify/App`.
- **IMPORTANT**: If you already have the `Mobile-Expensify` code, you don't need to run the command with `--init` flag.
Expand All @@ -95,7 +95,9 @@ The `patch-package` takes `.patch` files, and applies the diff to `node_modules`
If you need to setup your local environment, you can create a `.env` file in the root of the project (aka `Expensify/App`). The variables will be included into the **native build**, which means that in case of HybridApp they will be also visible on the OldDot side. There is no need to have another `.env` file in `Mobile-Expensify`.

If there are some connection problems with your local backend, please make sure you've included `ENVIRONMENT=development` in your `.env` file.
# Pro Tips & Troubleshooting

# Pro Tips and Troubleshooting

## General

### My build has just failed. What should I do?
Expand Down