Skip to content

Commit

Permalink
added DOI for current stable release
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasholderness committed Jun 28, 2017
1 parent e0ff914 commit 1f99683
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ Front-end code  
[Project description](https://github.com/urbanriskmap/petabencana-docs/blob/master/README.md)
<br>
<br>
This platform is built using the Aurelia framework, which has a few prerequisites. To get started, follow the machine & application setup steps.
This platform is built using the Aurelia framework, which has a few prerequisites. To get started, follow the machine & application setup steps.

DOI for current stable release [v1.0.0](https://github.com/urbanriskmap/petabencana.id/releases/tag/v1.0.0)

[![DOI](https://zenodo.org/badge/70249665.svg)](https://zenodo.org/badge/latestdoi/70249665)

____

Expand All @@ -14,19 +18,19 @@ ____
* You can [download it here](https://nodejs.org/en/).
* Install NPM 3.x
* 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`.
* Install Aurelia CLI
* Install Aurelia CLI
* `npm install aurelia-cli -g`

### Application setup
* Install the project dependencies
* Install the project dependencies
* `npm install`

___

### Project Structure
The project structure is as follows:
- **assets**: Static assets such as fonts, images, vector graphics, and icons
- **aurelia_project**: Aurelia generated folder containing config (Check Configuration section for more details) and framework specific libraries
- **aurelia_project**: Aurelia generated folder containing config (Check Configuration section for more details) and framework specific libraries
- **scripts**: Generated scripts from the build process
- **src**: The main application code with the following files and subfolders
* **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))
Expand All @@ -51,8 +55,8 @@ ___
### Routing
* *App router is configured in /src/app.js*
* '/' & '/map' *map landing page*
* '/map/:city' *query parameter (city): flyTo supported city*
* '/map/:city/:report' *query parameter (city & report): flyTo queried report id in a supported city*
* '/map/:city' *query parameter (city): flyTo supported city*
* '/map/:city/:report' *query parameter (city & report): flyTo queried report id in a supported city*
* '/cards/:id' *query parameter (one time card id): link to access report cards, (use test123 as card id in dev & local environments*

* *Additional query parameters*
Expand All @@ -64,12 +68,12 @@ ___

### Configuration
* Environments
* *to run in local, update the following values in /aurelia_project/environments/local.js*
* *to run in local, update the following values in /aurelia_project/environments/local.js*
* `debug` : (true/false) enable aurelia router logs in browser console
* `testing` : (true/false) enable aurelia-testing plugin
* `tile_layer` : set map tile source url (allows using multiple tileLayers for development, staging, production, etc)
* `data_server` : set url of cognicity server (Default value is http://localhost:8001/ if using [cognicity-server] (https://github.com/urbanriskmap/cognicity-server-v3))
* `app` : set it to map landing page url (Default value is http://localhost:9000/ if using this platform)
* `app` : set it to map landing page url (Default value is http://localhost:9000/ if using this platform)
* `default_language`: set it to one of the languages in `supported_languages` (Default is 'en')
* `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)
* `enable_test_cardid`: set to false to disable cardid=test123 in prod environments (Default is true for local and dev environments)
Expand Down Expand Up @@ -102,20 +106,20 @@ Testing environment supported by [BrowserStack](https://www.browserstack.com/)

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

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

##e2e testing:
##e2e testing:

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

Mockapi to be used in the future.
Mockapi to be used in the future.

## Contribution Guidelines

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

### Release

Expand Down

0 comments on commit 1f99683

Please sign in to comment.