Skip to content

Commit

Permalink
Merge pull request IQSS#96 from IQSS/feature/78-create-the-boilerplat…
Browse files Browse the repository at this point in the history
…e-of-the-dataset-page

78 - Create the boilerplate of the dataset page
  • Loading branch information
kcondon authored May 17, 2023
2 parents 9587173 + 97be785 commit 7be5dd7
Show file tree
Hide file tree
Showing 52 changed files with 4,296 additions and 29,066 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1 +1 @@
VITE_DATAVERSE_BACKEND_URL=http://localhost:8080
VITE_DATAVERSE_BACKEND_URL=https://demo.dataverse.org
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
# testing
/.nyc_output
/coverage
/tests/downloads
/tests/screenshots
/cypress/downloads
/cypress/screenshots
.nyc_output
/packages/design-system/coverage


Expand Down Expand Up @@ -44,3 +45,4 @@ yarn-error.log*
/dev-env/docker-dev-volumes
/dev-env/dataverse
/dev-env/dataverse-sample-data
/packages/design-system/.nyc_output
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Open [http://localhost:5173](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.

### `npm test:unit`
### `npm run test:unit`

Launches the test runner for the unit tests in the interactive watch mode.
If you prefer to see the tests executing in cypress you can run `npm run cy:open-unit`
Expand Down Expand Up @@ -59,8 +59,12 @@ Launches the prettier formatter. We recommend you to configure your IDE to run p

### `npm run storybook`

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

There are 2 Storybook instances, one for the Design System and one for the Dataverse Frontend.

Open [http://localhost:6006](http://localhost:6006) to view the Dataverse Frontend Storybook in your browser.
Open [http://localhost:6007](http://localhost:6007) to view the Design System Storybook in your browser.

## Local development environment

Expand Down Expand Up @@ -161,8 +165,16 @@ It is important that the remote instance is correctly pre-configured, with the P

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.

## Changes in the Style Guide
## Changes from the Style Guide

The design system and frontend in this repo are inspired by the Dataverse Project [Style Guide](https://guides.dataverse.org/en/latest/style/index.html), but the following changes have been made, especially for accessibility.

### Links

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

### File label

Now we are using Bootstrap with a theme, so there is only one definition for the secondary color. Since Bootstrap applies
the secondary color to the labels automatically, the color of the file label is now the global secondary color which is
a lighter shade of grey than what it used to be.
2 changes: 1 addition & 1 deletion cypress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import path from 'path'
export default defineConfig({
video: false,
e2e: {
baseUrl: 'http://localhost:5173',
baseUrl: 'http://localhost:5173/spa',
specPattern: 'tests/e2e/**/*.spec.{js,jsx,ts,tsx}',
screenshotOnRunFailure: false,
video: false,
Expand Down
4 changes: 0 additions & 4 deletions dev-env/.env

This file was deleted.

2 changes: 1 addition & 1 deletion merged-coverage/lcov.info
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ DA:36,108
BRDA:24,0,0,54
BRDA:24,0,1,165
end_of_record
SF:packages/design-system/src/lib/components/icon.enum.ts
SF:packages/design-system/src/lib/components/Icon.enum.ts
DA:1,72
DA:2,72
DA:3,72
Expand Down
Loading

0 comments on commit 7be5dd7

Please sign in to comment.