Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

78 - Create the boilerplate of the dataset page #96

Merged
merged 25 commits into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
0cfc139
feat(Dataset): add new page
MellyGray May 4, 2023
f8f0af3
feat(DatasetBoilerplate): show Dataset title in the Dataset page
MellyGray May 4, 2023
60ba868
feat(DatasetBoilerplate): add data version number
MellyGray May 4, 2023
4a82000
feat(Dataset Boilerplate): add DatasetLabels component
MellyGray May 10, 2023
a0c2b83
feat(Dataset Boilerplate): add LoadingProvider
MellyGray May 10, 2023
da3a714
feat(Dataset Boilerplate): handle isLoading and no dataset found states
MellyGray May 10, 2023
1f5e840
feat(Dataset Boilerplate): add tests for Dataset page states
MellyGray May 11, 2023
3155cb4
feat(Dataset Boilerplate): get dataset id from route parameters
MellyGray May 11, 2023
06641d4
fix(Github Action): modify test to run on github actions
MellyGray May 11, 2023
b10394e
Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …
MellyGray May 12, 2023
29a611d
fix(Design System): remove cascade layers
MellyGray May 12, 2023
3574cda
fix(npm start): remove server
MellyGray May 12, 2023
04aeac4
fix(coverage): add tests
MellyGray May 12, 2023
e01b97e
feat(PageNotFound): use the Alert component
MellyGray May 12, 2023
f50dbf7
feat(Dataset Boilerplate): add translations
MellyGray May 12, 2023
596a0aa
fix(Route): datasets route in plural
MellyGray May 12, 2023
d245c4a
fix(dev-env):restore dev-env files
MellyGray May 15, 2023
10b0bcf
fix: add packages/design-system/.nyc_output to .gitignore
MellyGray May 15, 2023
3d7e8e8
fix(.env): typo in backend_url
MellyGray May 15, 2023
5659f05
fix(README): update Storybook ports
MellyGray May 16, 2023
bd45ca2
feat(README): add change in the style guide
MellyGray May 16, 2023
1d5bb86
clean up Changes from the Style Guide #78
pdurbin May 16, 2023
da8ed00
change to Dataverse Title to be more realistic #78
pdurbin May 16, 2023
35d7177
fix test:unit command
pdurbin May 16, 2023
5291c38
fix(e2e): missing configuration details
MellyGray May 16, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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