This project was bootstrapped with Create React App.
To run this app, you need to add a set of environment variables to a .env file located at the root of the project folder (/NVA-Frontend/.env).
A minimal working example for .env that uses a simplistic set of (incomplete) mock data looks as follows:
VITE_API_HOST=api.dev.nva.aws.unit.no
VITE_USE_MOCK=trueInfo about all environment variables are listed in the table below. Note that you must be authorized to retrieve some of these values if you don't want to use mock data.
| Name | Example value | Description |
|---|---|---|
| VITE_API_HOST | api.dev.nva.aws.unit.no |
Required. Base URL to the API. Value can be found by logging in to the Parameter Store in AWS. (/NVA/ApiDomain) |
| VITE_USE_MOCK | false |
Whether to use local mock data or not. If true, no more variables are needed. |
| VITE_REDIRECT_SIGN_IN | http://localhost:3000 |
Callback URI for successfull login. |
| VITE_REDIRECT_SIGN_OUT | http://localhost:3000/logout |
Callback URI for successfull logout. |
| VITE_AWS_USER_POOLS_ID | eu-west-1:XXXXXXXXXX |
Value can be found by logging in to the Parameter Store in AWS. (CognitoUserPoolId) |
| VITE_AWS_USER_POOLS_WEB_CLIENT_ID | XXXXXXXXXX |
Value can be found by logging in to the Parameter Store in AWS. (CognitoUserPoolAppClientId) |
| VITE_DOMAIN | XXXXXXXXX.auth.eu-west-1.amazoncognito.com |
Value can be found by logging in to the Parameter Store in AWS. (CognitoAuthenticationDomain) |
| VITE_ORCID_BASE_URL | https://sandbox.orcid.org |
Base URL to ORCID integration. |
| VITE_ORCID_CLIENT_ID | APP-XXXXXXXXX |
Value can be found by logging in to the Secrets Manager in AWS (OrcidClientID) or ORCID Admin dashboard. |
| CYPRESS_RECORD_KEY | XXXXXXXXXX |
Value can be found by logging in to the Secrets Manager in AWS (CypressRecordKey) or Cypress Dashboard |
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Runs cypress tests.
Alternatively:
- Set environment variable in
.env:VITE_USE_MOCK=true npm startnpx cypress runornpx cypress open
Cypress dashboard (requires access) displays details from test runs.
Lokalise allows translating content in a user-friendly web portal. For more information about our preferred workflow when working with translations, see description on translations.md.
Socket Security is used to ensure legitimacy of installed NPM packages for each PR.
Distributed under the MIT license. See LICENSE for details.