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

Jump to bottom

[NoQA] Update "Troubleshooting" docs #5262

Merged
merged 4 commits into from
Sep 30, 2021
Merged

[NoQA] Update "Troubleshooting" docs #5262

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7708048
tips regarding .env variables
kidroca Sep 15, 2021
5a9648f
docs: troubleshooting regarding CORS issues
kidroca Sep 15, 2021
5e59ff4
Readme: Apply suggestions from code review
kidroca Sep 29, 2021
7815def
Update README.md add dashes to the rest ENV vars
kidroca Sep 29, 2021
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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,27 @@ You can use any IDE or code editing tool for developing on any platform. Use you

## Troubleshooting
1. If you are having issues with **_Getting Started_**, please reference [React Native's Documentation](https://reactnative.dev/docs/environment-setup)
2. If you are running into issues communicating with the API please verify your `.env` file is [set up correctly](#getting-started) for the platform you are trying to run.
2. If you are running into CORS errors like (in the browser dev console)
```sh
Access to fetch at 'https://www.expensify.com/api?command=GetAccountStatus' from origin 'http://localhost:8080' has been blocked by CORS policy
```
You probably have a misconfigured `.env` file - remove it and try again `rm .env`
kidroca marked this conversation as resolved.
Show resolved Hide resolved

**Note:** Expensify engineers that will be testing with the API in your local dev environment please refer to [these additional instructions](https://stackoverflow.com/c/expensify/questions/7699/7700).

## Environment variables
Creating an `.env` file is not necessary. We advise external contributors against it. It can lead to errors when
variables referenced here get updated since your local `.env` file is ignored.

- `USE_WEB_PROXY` ⚠️used in web/desktop development, it starts a server along the local development server to proxy
kidroca marked this conversation as resolved.
Show resolved Hide resolved
kidroca marked this conversation as resolved.
Show resolved Hide resolved
requests to the backend. External contributors should set this to `true` otherwise they'll have CORS errors.
If you don't want to start the proxy server set this explicitly to `false`
kidroca marked this conversation as resolved.
Show resolved Hide resolved
- `CAPTURE_METRICS` (optional) set this to `true` to capture performance metrics and see them in Flipper
see [PERFORMANCE.md](PERFORMANCE.md#performance-metrics-opt-in-on-local-release-builds) for more information
- `ONYX_METRICS` (optional) set this to `true` to capture even more performance metrics and see them in Flipper
see [React-Native-Onyx#benchmarks](https://github.com/Expensify/react-native-onyx#benchmarks) for more information


----

# Running the tests
Expand Down