Skip to content

Commit 1f99683

Browse files
added DOI for current stable release
1 parent e0ff914 commit 1f99683

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ Front-end code  
55
[Project description](https://github.com/urbanriskmap/petabencana-docs/blob/master/README.md)
66
<br>
77
<br>
8-
This platform is built using the Aurelia framework, which has a few prerequisites. To get started, follow the machine & application setup steps.
8+
This platform is built using the Aurelia framework, which has a few prerequisites. To get started, follow the machine & application setup steps.
9+
10+
DOI for current stable release [v1.0.0](https://github.com/urbanriskmap/petabencana.id/releases/tag/v1.0.0)
11+
12+
[![DOI](https://zenodo.org/badge/70249665.svg)](https://zenodo.org/badge/latestdoi/70249665)
913

1014
____
1115

@@ -14,19 +18,19 @@ ____
1418
* You can [download it here](https://nodejs.org/en/).
1519
* Install NPM 3.x
1620
* Even though you may have the latest NodeJS, that doesn't mean you have the latest version of NPM. You can check your version with `npm -v`. If you need to update, run `npm install npm -g`.
17-
* Install Aurelia CLI
21+
* Install Aurelia CLI
1822
* `npm install aurelia-cli -g`
1923

2024
### Application setup
21-
* Install the project dependencies
25+
* Install the project dependencies
2226
* `npm install`
2327

2428
___
2529

2630
### Project Structure
2731
The project structure is as follows:
2832
- **assets**: Static assets such as fonts, images, vector graphics, and icons
29-
- **aurelia_project**: Aurelia generated folder containing config (Check Configuration section for more details) and framework specific libraries
33+
- **aurelia_project**: Aurelia generated folder containing config (Check Configuration section for more details) and framework specific libraries
3034
- **scripts**: Generated scripts from the build process
3135
- **src**: The main application code with the following files and subfolders
3236
* **components**: Contains custom-elements to be used in routes (Read more about Aurelia Custom Elements [here](http://aurelia.io/hub.html#/doc/article/aurelia/framework/latest/cheat-sheet/9))
@@ -51,8 +55,8 @@ ___
5155
### Routing
5256
* *App router is configured in /src/app.js*
5357
* '/' & '/map' *map landing page*
54-
* '/map/:city' *query parameter (city): flyTo supported city*
55-
* '/map/:city/:report' *query parameter (city & report): flyTo queried report id in a supported city*
58+
* '/map/:city' *query parameter (city): flyTo supported city*
59+
* '/map/:city/:report' *query parameter (city & report): flyTo queried report id in a supported city*
5660
* '/cards/:id' *query parameter (one time card id): link to access report cards, (use test123 as card id in dev & local environments*
5761

5862
* *Additional query parameters*
@@ -64,12 +68,12 @@ ___
6468

6569
### Configuration
6670
* Environments
67-
* *to run in local, update the following values in /aurelia_project/environments/local.js*
71+
* *to run in local, update the following values in /aurelia_project/environments/local.js*
6872
* `debug` : (true/false) enable aurelia router logs in browser console
6973
* `testing` : (true/false) enable aurelia-testing plugin
7074
* `tile_layer` : set map tile source url (allows using multiple tileLayers for development, staging, production, etc)
7175
* `data_server` : set url of cognicity server (Default value is http://localhost:8001/ if using [cognicity-server] (https://github.com/urbanriskmap/cognicity-server-v3))
72-
* `app` : set it to map landing page url (Default value is http://localhost:9000/ if using this platform)
76+
* `app` : set it to map landing page url (Default value is http://localhost:9000/ if using this platform)
7377
* `default_language`: set it to one of the languages in `supported_languages` (Default is 'en')
7478
* `supported_languages`: set it to an array of languages you support (Default is ['en', 'id']. In case you add more languages, update the array and add corresponding locale information in /src/resources/locales/TWO_LETTER_LANGUAGE_CODE.js)
7579
* `enable_test_cardid`: set to false to disable cardid=test123 in prod environments (Default is true for local and dev environments)
@@ -102,20 +106,20 @@ Testing environment supported by [BrowserStack](https://www.browserstack.com/)
102106

103107
Do ('npm test') to build the project and run the tests.
104108

105-
If you want to run BrowserStack, you need to provide environment variables with your
106-
username and password. Put `export BROWSERSTACK_USERNAME=yourUsername` and `export BROWSERSTACK_KEY=yourAccessKey` into
107-
your ~/.bashrc or ~/.bash_profile in order for karma to pick up the browserstack credentials. Now run `source ~/bash_profile` and
108-
npm test in order to build the bundle and run karama unit tests against it.
109+
If you want to run BrowserStack, you need to provide environment variables with your
110+
username and password. Put `export BROWSERSTACK_USERNAME=yourUsername` and `export BROWSERSTACK_KEY=yourAccessKey` into
111+
your ~/.bashrc or ~/.bash_profile in order for karma to pick up the browserstack credentials. Now run `source ~/bash_profile` and
112+
npm test in order to build the bundle and run karama unit tests against it.
109113

110-
##e2e testing:
114+
##e2e testing:
111115

112-
End to end testing is implemented using protractor, webdriver, and browserstack. First install protractor: `npm install -g protractor` then download the webdriver binaries: `webdriver-manager update`. In order to run the tests, the front end must be being served. Run au run in a separate terminal, and then run `protractor protractor.conf.js` which will start the tests. Protractor can be a little finicky, so you should let it run without interacting with other browser windows.
116+
End to end testing is implemented using protractor, webdriver, and browserstack. First install protractor: `npm install -g protractor` then download the webdriver binaries: `webdriver-manager update`. In order to run the tests, the front end must be being served. Run au run in a separate terminal, and then run `protractor protractor.conf.js` which will start the tests. Protractor can be a little finicky, so you should let it run without interacting with other browser windows.
113117

114-
Mockapi to be used in the future.
118+
Mockapi to be used in the future.
115119

116120
## Contribution Guidelines
117121

118-
- Issues are tracked on [github](https://github.com/urbanriskmap/petabencana.id/issues).
122+
- Issues are tracked on [github](https://github.com/urbanriskmap/petabencana.id/issues).
119123

120124
### Release
121125

0 commit comments

Comments
 (0)