First install node >=16 and npm >=8. Recommended versions node v19 and npm v9.

Run this command to install the dependencies. You may see a message about vulnerabilities after running this command.
Please check this announcement from Create React App repository facebook/create-react-app#11174 . These vulnerabilities won't be in the production build since they come from libraries only used during the development.

In the project directory, you can run at any time:

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

The page will reload when you make changes.
You may also see any lint errors in the console.

Launches the test runner for the unit tests in the interactive watch mode.

Builds the app for production to the dist folder.

Locally preview the production build.

Launches the Cypress test runner for the end-to-end tests.
If you prefer to see the tests executing in cypress you can run npm run cy:open

Launches the linter. To automatically fix the errors run npm run lint:fix

Launches the prettier formatter. We recommend you to configure your IDE to run prettier on save.

Runs the Storybook in the development mode.
Open http://localhost:6006 to view it in your browser.

Once the site is built through the npm run build command, it can be deployed in different ways to different types of infrastructure, depending on installation needs.

We are working to provide different preconfigured automated deployment options, seeking to support common use cases today for installing applications of this nature.

The current automated deployment options are available within the GitHub deploy workflow, which is designed to be run manually from GitHub Actions. The deployment option is selected via a dropdown menu, as well as the target environment.

This option will build and deploy the application to a remote S3 bucket.

For this workflow to work, a GitHub environment must be configured with the following environment secrets:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_S3_BUCKET_NAME
• AWS_DEFAULT_REGION

Note that for the deployment to the S3 bucket to succeed, you must make the following changes to the bucket via the S3 web interface (or equivalent changes using aws-cli or similar tools):

• Under "Permissions", "Permissions overview", "Block public access (bucket settings)", click "Edit", then uncheck "Block all public access" and save.
• Under "Properties", "Static website hosting", click "Edit" and enable it. Change "Index document" and "Error document" to "index.html".
• Under "Bucket policy", click "Edit" and paste the following policy (changing <BUCKET_NAME> to your bucket name) and save.

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Sid": "PublicReadGetObject",
			"Principal": "*",
			"Effect": "Allow",
			"Action": [
				"s3:GetObject"
			],
			"Resource": [
				"arn:aws:s3:::<BUCKET_NAME>/*"
			]
		}
	]
}

You should see the deployed app at http://BUCKET-NAME.s3-website-REGION.amazonaws.com such as http://mybucket.s3-website-us-east-1.amazonaws.com

This option will build and deploy the application to a remote Payara server.

This option is intended for an "all-in-one" solution, where the Dataverse backend application and the frontend application run on the same Payara server.

For this workflow to work, a GitHub environment must be configured with the following environment secrets:

• PAYARA_INSTANCE_HOST
• PAYARA_INSTANCE_USERNAME
• PAYARA_INSTANCE_SSH_PRIVATE_KEY

It is important that the remote instance is correctly pre-configured, with the Payara server running, and a service account for Dataverse with the corresponding SSH key pair established.

A base path for the frontend application can be established on the remote server by setting the corresponding field in the workflow inputs. This mechanism prevents conflicts between the frontend application and any pre-existing deployed application running on Payara, which can potentially be a Dataverse backend. This way, only the routes with the base path included will redirect to the frontend application.

We added the underline to the links to make them accessible.