You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-19
Original file line number
Diff line number
Diff line change
@@ -44,20 +44,20 @@ If you are here to test out the app on your personal phone, please use the open-
44
44
45
45
In general, if you are planning to keep the app installed for less than a day, please use stage so you don't pollute the real dataset.
46
46
47
-
#### Testing configs
47
+
#### Testing local configs on e-mission-phone
48
48
49
-
As we test more config options, we sometimes need to be able to edit and load configs locally without pushing to github
50
-
and waiting for a PR to be approved.
49
+
As we test more config options, we sometimes need to be able to test local config changes without pushing to GitHub and waiting for a PR to be approved.
51
50
52
51
To accomplish this:
53
-
- Change the download URL in `www/js/config/dynamic_config.js` to `"http://localhost:9090/configs/"+label+".nrel-op.json"`
54
-
- Modify one of the existing configs **OR** create a new config and add it to `docs/index.html`
55
-
-`docker-compose -f docker-compose.dev.yml up -d`
56
-
- In the emulator, go to http://localhost:9090 and click on the appropriate link
52
+
- Modify one of the existing configs in your local repo or create a new one (e.g. my-deployment.nrel-op.json)
53
+
-`docker-compose -f docker-compose.dev.yml up -d` to serve your local configs on localhost:9090
54
+
- With an emulator running e-mission-phone, log in with an opcode for that deployment (e.g. nrelop_my-deployment_1234)
55
+
- As long as you are not using a 'production' build of e-mission-phone, the app will check localhost:9090 before it checks GitHub
56
+
- You can use "Profile" > "Refresh App Configuration" to quickly test additional changes as long as "version" is incremented in your new version of the config
57
57
58
-
### File format
58
+
### Config options
59
59
60
-
Config format (with default values) is:
60
+
Example config format (with default values) is:
61
61
62
62
```
63
63
{
@@ -95,13 +95,4 @@ Config format (with default values) is:
95
95
}
96
96
```
97
97
98
-
### Development
99
-
100
-
This repo has some simple GitHub pages in the `docs` repo
101
-
102
-
If you want to experiment with them (e.g. by changing the format or the URL
103
-
prefix), you can use the attached `docker-compose.yml` to serve the pages
104
-
locally at http://localhost:9090
105
-
106
-
I found this useful while testing the QR code functionality on the devapp,
107
-
which responds to the `emission` URL prefix, not `nrelopenpath`
98
+
A TypeScript specification of all the available config options is available in `index.d.ts`.
0 commit comments