Skip to content

Latest commit

 

History

History
80 lines (67 loc) · 2.99 KB

README.md

File metadata and controls

80 lines (67 loc) · 2.99 KB
Raw

Urban Risk Map Cards

Urban Risk Map reporting cards web-app.

Development server

Run npm run start (for default deployment jp) or dep=cc npm run pre-build-tasks && ng serve (for deployment with code cc) for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Adding a new deployment

  1. Run export dep='xx' & npm run add-deployment to create the scaffolding for a new deployment.
  2. The following files will be added in the specified folders:
  • src/environments/xx
    • environment.json
    • environment.prod.json
  • deployments/xx/
    • index.html
    • /assets
      • /icons
      • /images
      • /locales
        • en.json
      • /logos
    • /resources
  1. angular.json will be modified to add deployment configurations.
  2. package.json will be modified to add build scripts.
  3. The default deck that will be served is flood.
  4. To test the deployment locally, change the deployment variable in package.json > scripts.start, run npm start, and open http://localhost:4200/test123/flood in the browser.

Adding a new deck of cards

  1. Run export deck=sample & npm run add-deck to create a route to a new cards deck.
  2. This will add a new folder, sample in src/app/routes/decks, including the following:
  • sample-routing.module.ts
  • sample.component.html
  • sample.component.scss
  • sample.component.spec.ts
  • sample.component.ts
  • sample.module.ts
  1. Add a new object to the list of "decks" in src/environments/$dep/environment.json for the respective deployments, with the following structure:
{
  "decks": [
    "name": "sample",
    "cards": [
      "location"
    ]
  ]
}
  1. To test the deck locally, change the deployment variable in package.json > scripts.start to $dep for which the environment file was modified in Step 3, run npm start, and open http://localhost:4200/test123/sample.

Adding new cards

  1. Run export card=card_name & npm run add-card to create a route to a new card.
  2. Add card_name to the list of 'cards' in src/environments/$dep/environment.json for the desired deck object, eg.
{
  "decks": [
    "name": "flood",
    "cards": [
      "card_name"
    ]
  ]
}
  1. To test the card locally, change the deployment variable in package.json > scripts.start to $dep for which the environment file was modified in Step 2, run npm start, and open http://localhost:4200/test123/flood/card_name.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.