Skip to content

Commit 24e8959

Browse files
committed
remove unused files, update README
- update README - remove /docs (all current docs are either in this repo's README or in e-mission-docs) - remove qr_code_images
1 parent ae939f1 commit 24e8959

File tree

10 files changed

+10
-2942
lines changed

10 files changed

+10
-2942
lines changed

README.md

+10-19
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,20 @@ If you are here to test out the app on your personal phone, please use the open-
4444

4545
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.
4646

47-
#### Testing configs
47+
#### Testing local configs on e-mission-phone
4848

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.
5150

5251
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
5757

58-
### File format
58+
### Config options
5959

60-
Config format (with default values) is:
60+
Example config format (with default values) is:
6161

6262
```
6363
{
@@ -95,13 +95,4 @@ Config format (with default values) is:
9595
}
9696
```
9797

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`.

docs/.nojekyll

Whitespace-only changes.

docs/index.html

-77
This file was deleted.

docs/lib/angular-qrcode/angular-qrcode.js

-233
This file was deleted.

docs/lib/ionic/css/ionic.min.css

-23
This file was deleted.

docs/lib/ionic/js/ionic.bundle.min.js

-472
This file was deleted.

0 commit comments

Comments
 (0)