Skip to content

Latest commit

 

History

History
148 lines (102 loc) · 6.37 KB

README.md

File metadata and controls

148 lines (102 loc) · 6.37 KB

Amazon Location Features Demo Web

Requirements

  1. Run the CF template or use the template from /extra/cloudformation/default-unauth-resources-template.yaml to create a cloudformation stack on AWS in us-east-1 region using your own AWS account and get IdentityPoolId, PinPointAppId, WebSocketUrl from stack output's tab.
    • IdentityPoolId value will be added to .env file against VITE_AWS_COGNITO_IDENTITY_POOL_IDS and VITE_PINPOINT_IDENTITY_POOL_ID.
    • PinPointAppId value will be added to .env file against VITE_PINPOINT_APPLICATION_ID.
    • WebSocketUrl value will be added to .env file against VITE_AWS_WEB_SOCKET_URLS.
  2. Run the CF template or use the template from /extra/cloudformation/default-unauth-resources-template.yaml to create a cloudformation stack on AWS in ap-southeast-1 region using your own AWS account and get IdentityPoolId, WebSocketUrl from stack output's tab [Necessary if you want GrabMaps to be enabled].
    • IdentityPoolId value will be added to .env file against VITE_AWS_COGNITO_IDENTITY_POOL_IDS (comma separated for multiple values).
    • WebSocketUrl value will be added to .env file against VITE_AWS_WEB_SOCKET_URLS (comma separated for multiple values).
  3. Value for VITE_AWS_CF_TEMPLATE, VITE_APPLE_APP_STORE_LINK, VITE_GOOGLE_PLAY_STORE_LINK can be added as it is to .env file from .env.examples.
  4. Value for VITE_APP_VERSION needs to be populated with the correct version at the time of deployment in the following format 2.1.0.

Env keys required in .env file, see .env.example for reference

VITE_AWS_COGNITO_IDENTITY_POOL_IDS
VITE_AWS_WEB_SOCKET_URLS
VITE_PINPOINT_IDENTITY_POOL_ID
VITE_PINPOINT_APPLICATION_ID
VITE_AWS_CF_TEMPLATE
VITE_APPLE_APP_STORE_LINK
VITE_GOOGLE_PLAY_STORE_LINK
VITE_APP_VERSION

Configure

git clone <REPO_URL>
cd amazon-location-features-demo-web/
npm install
npm run dev

npm install

Installs all the dependencies.

npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

E2E Tests

Env keys required in cypress.env.json file, see cypress.env.json.example for reference.

WEB_DOMAIN
WEB_DOMAIN_USERNAME
WEB_DOMAIN_PASSWORD
IDENTITY_POOL_ID
USER_DOMAIN
USER_POOL_CLIENT_ID
USER_POOL_ID
WEB_SOCKET_URL
COGNITO_EMAIL
COGNITO_PASSWORD

If you are configuring Github actions fo the e2e tests, make sure to add these keys to the secrets section of the repo with a CYPRESS_ prefix.

npm run cypress

Runs Cypress tests to completion in a headed chrome browser.

npm run cypress run

Runs Cypress tests to completion. By default, cypress run will run all tests headlessly. https://docs.cypress.io/guides/guides/command-line#cypress-run

npm run cypress open

Runs Cypress tests to completion in a browser which can be specified in the options. https://docs.cypress.io/guides/guides/command-line#cypress-open

Security Tests

Env keys required in security-tests/.env file, see security-tests/.env.example for reference.

VITE_AWS_COGNITO_IDENTITY_POOL_ID_TEST
VITE_AWS_USER_POOL_ID_TEST
VITE_AWS_USER_POOL_WEB_CLIENT_ID_TEST
VITE_AWS_COGNITO_USERNAME_TEST
VITE_AWS_COGNITO_PASSWORD_TEST
VITE_AWS_IAM_AUTH_ROLE_NAME_TEST
VITE_AWS_IAM_UNAUTH_ROLE_NAME_TEST

npm run security-tests

Runs Security tests insuring policies match the expected values.

Unit Tests

Env keys required in .env.

VITE_PINPOINT_IDENTITY_POOL_ID
VITE_PINPOINT_APPLICATION_ID

npm run test

Run all the test cases for all the components within the repo.

npm run coverage

Run all the test cases for all the components within the repo and provides a coverage report.

Resources

Amazon Location Service

Maps (Name - Style)

  • location.aws.com.demo.maps.Esri.DarkGrayCanvas - VectorEsriDarkGrayCanvas
  • location.aws.com.demo.maps.Esri.Imagery - RasterEsriImagery
  • location.aws.com.demo.maps.Esri.Light - VectorEsriTopographic
  • location.aws.com.demo.maps.Esri.LightGrayCanvas - VectorEsriLightGrayCanvas
  • location.aws.com.demo.maps.Esri.Navigation - VectorEsriNavigation
  • location.aws.com.demo.maps.Esri.Streets - VectorEsriStreets
  • location.aws.com.demo.maps.HERE.Explore - VectorHereExplore
  • location.aws.com.demo.maps.HERE.Contrast - VectorHereContrast
  • location.aws.com.demo.maps.HERE.ExploreTruck - VectorHereExploreTruck
  • location.aws.com.demo.maps.HERE.Hybrid - HybridHereExploreSatellite
  • location.aws.com.demo.maps.HERE.Imagery - RasterHereExploreSatellite
  • location.aws.com.demo.maps.Grab.StandardLight - VectorGrabStandardLight
  • location.aws.com.demo.maps.Grab.StandardDark - VectorGrabStandardDark
  • location.aws.com.demo.maps.OpenData.StandardLight - VectorOpenDataStandardLight
  • location.aws.com.demo.maps.OpenData.StandardDark - VectorOpenDataStandardDark
  • location.aws.com.demo.maps.OpenData.VisualizationLight - VectorOpenDataVisualizationLight
  • location.aws.com.demo.maps.OpenData.VisualizationDark - VectorOpenDataVisualizationDark

Place indexes (Name)

  • location.aws.com.demo.places.Esri.PlaceIndex
  • location.aws.com.demo.places.HERE.PlaceIndex
  • location.aws.com.demo.places.Grab.PlaceIndex

Route calculators (Name)

  • location.aws.com.demo.routes.Esri.RouteCalculator
  • location.aws.com.demo.routes.HERE.RouteCalculator
  • location.aws.com.demo.routes.Grab.RouteCalculator

Geofence collections (Name)

  • location.aws.com.demo.geofences.GeofenceCollection

Trackers (Name)

  • location.aws.com.demo.trackers.Tracker

Licensing

  • This project is licensed under the MIT-0 License. See LICENSE.