Skip to content

Commit 36b32e9

Browse files
committed
Add example .env file and accompanying docs
1 parent 21f2d93 commit 36b32e9

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
DEV_URL=https://hmda-development-server.example.com
2+
MAPBOX_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,12 @@ Several components of the Frontend (ex. Filing, Data Browser) require a connecti
140140

141141
HMDA Help requires a connection to the [HMDA Institutions API](https://github.com/cfpb/hmda-platform/tree/master/institutions-api) in order to operate. You can find instructions for the running the HMDA Institutions API locally [in the README](https://github.com/cfpb/hmda-platform/blob/master/institutions-api/README.md). Note that having the HMDA Platform running is a pre-requisite to starting the HDMA Institutions API.
142142

143-
If your development does not require this integration, `yarn start` will run the development server, opening a browser window to http://localhost:3000.
143+
If your development does not require this integration, you can simply:
144+
145+
1. Copy `.env.example` to `.env` and edit the environment variables.
146+
- `DEV_URL` is the URL that the frontend app will use for API requests. It should not have a trailing slash.
147+
- `MAPBOX_ACCESS_TOKEN` is the access token provided by Mapbox.com for the app's embedded maps.
148+
2. Run `yarn start` to start a local development server at http://localhost:3000.
144149

145150
#### Integrating with the Filing application
146151

0 commit comments

Comments
 (0)