Skip to content

Commit

Permalink
tips regarding .env variables
Browse files Browse the repository at this point in the history
Describe some environment variables and specifically the USE_WEB_PROXY
as it's causes issues for external contributors
  • Loading branch information
kidroca committed Sep 15, 2021
1 parent 9032d31 commit 7708048
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ These instructions should get you set up ready to work on New Expensify 🙌
1. Install `node` & `npm`: `brew install node`
2. Install `watchman`: `brew install watchman`
3. Install dependencies: `npm install`
4. Create a `.env` file, use [.env.staging](.env.staging) as a source.
External contributors should set `USE_WEB_PROXY=true` (Otherwise they'll get CORS errors)

You can use any IDE or code editing tool for developing on any platform. Use your favorite!

Expand Down Expand Up @@ -59,6 +61,16 @@ You can use any IDE or code editing tool for developing on any platform. Use you

**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
- `USE_WEB_PROXY` ⚠️used in web/desktop development, it starts a server along the local development server to proxy
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`
- `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

0 comments on commit 7708048

Please sign in to comment.