Note
This repository has been archived, because it is considered feature-complete. ✔️
The nRF Asset Tracker Web Application for AWS is a reference single-page application (SPA) developed with React in TypeScript.
The UI components are themed using Bootstrap 5 and CSS modules. All complex UI logic is extracted using React hooks to allow re-use when changing the UI framework.
Vite is used as the frontend toolchain.
npm ci
In the
nRF Asset Tracker for AWS
folder, run node cli web-app-config and store the output in a local .envrc
file. Then run direnv allow to allow it.
# .envrc
export PUBLIC_CELL_GEO_LOCATION_CACHE_TABLE_NAME=...
export PUBLIC_CLOUDFRONT_DISTRIBUTION_ID=...
export PUBLIC_FOTA_BUCKET_NAME=...
export PUBLIC_GEOLOCATION_API_URL=...
export PUBLIC_HISTORICALDATA_TABLE_INFO=...
export PUBLIC_IDENTITY_POOL_ID=...
export PUBLIC_NETWORK_SURVEY_GEOLOCATION_API_URL=...
export PUBLIC_NETWORKSURVEY_STORAGE_TABLE_NAME=...
export PUBLIC_USER_IOT_POLICY_NAME=...
export PUBLIC_USER_POOL_ID=...
export PUBLIC_USER_POOL_CLIENT_ID=...
export PUBLIC_WEB_APP_BUCKET_NAME=...
export PUBLIC_WEB_APP_DOMAIN_NAME=...
export PUBLIC_SENTRY_DSN=...
export PUBLIC_REGION=...
export PUBLIC_MQTT_ENDPOINT=...npm start
The frontend provides end-to-end tests using Playwright.
The end-to-end tests run against an instance of the nRF Asset Tracker for AWS.
Either, use the existing authentication from setting up the solution, or enable the Web App CI feature and use the dedicated credentials created for this task. The latter option is the recommended approach since it limits the permission scope to only the needed ones. They can also be used to run the end-to-end tests on GitHub Actions.
Add these environment variables to your .envrc. Then run direnv allow to
allow it.
# .envrc
export AWS_REGION=...
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export WEBAPP_STACK_NAME=...You can then run the tests using
npm run test:e2e
npx playwright test authenticated/map/locationHistory/gnss.spec.ts
For developing tests it is helpful to run the Playwright Inspector.
You can enabled the inspector during the tests by running
PWDEBUG=1 npm run test:e2e
This workflow runs the end-to-end tests for every commit. For this to work a running instance of nRF Asset Tracker for AWS is needed. The tests will be run against this instance. Typically it will be the production instance, to ensure that the web application works with the current production setup.
In order for the test runner to interact with the instance for retrieving the app configuration and for providing test data you need to configure AWS credentials as GitHub environment secrets.
Set these secrets:
AWS_REGIONAWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYWEBAPP_STACK_NAME
If you have enabled the web application CI of the nRF Asset Tracker for AWS
(node cli configure context stack web-app-ci 1) you can acquire them using the
nRF Asset Tracker for AWS CLI:
node cli web-app-ci -sYou can set the secrets through the GitHub UI (make sure to create the
production
environment
in your repository first).
Alternatively you can use the GitHub CLI using the environment settings from above:
gh secret set AWS_REGION --env production --body "${AWS_REGION}"
gh secret set AWS_ACCESS_KEY_ID --env production --body "${AWS_ACCESS_KEY_ID}"
gh secret set AWS_SECRET_ACCESS_KEY --env production --body "${AWS_SECRET_ACCESS_KEY}"
gh secret set WEBAPP_STACK_NAME --env production --body "${WEBAPP_STACK_NAME}"Optionally, Sentry can be enabled for the web application. Export the
PUBLIC_SENTRY_DSN environment variable.
To enable this in the continuous deployment pipeline of nRF Asset Tracker, configure the DSN using the CLI:
./cli.sh configure thirdParty sentry sentryDsn https://4f901247818d46099a3f15b6ada9390e@o4504255385174016.ingest.sentry.io/4504684789170176When the next deployment is triggered, the DSN becomes available via
./cli.sh web-app-config