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

312 - Integration file citation #317

Merged
merged 2 commits into from
Feb 23, 2024

Conversation

MellyGray
Copy link
Contributor

What this PR does / why we need it:

This PR adds the integration of the UI with the js-dataverse implementation to get the file citation.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Step 1: Run the development environment

  1. Run npm I
  2. cd packages/design-system && npm run build
  3. cd ../../
  4. Check that you have a .env file such as the .env.example, with the VITE_DATAVERSE_BACKEND_URL=http://localhost:8000 variable
  5. cd dev-env
  6. ./run-env.sh unstable
  7. To check the environment go to http://localhost:8000 and check your local dataverse installation

Step 2: Test File Page

  1. Go to http://localhost:8000
  2. Login as admin using username: dataverseAdmin and password: admin1
  3. Create a new Dataset
  4. Upload a file to the dataset
  5. From the dataset view mode click on some file to go to the File Page in JSF
  6. From the url copy the fileId number
  7. Go to http://localhost:8000/spa/files and paste the fileId number as an id query param to go to the SPA version of the File Page. Ex.: http://localhost:8000/spa/files?id=212121
  8. You are currently viewing the same file in the SPA. Check the file citation text, it should match the JSF version.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@MellyGray MellyGray linked an issue Feb 21, 2024 that may be closed by this pull request
@coveralls
Copy link

Coverage Status

coverage: 97.454%. remained the same
when pulling 5c76922 on feature/312-integration-file-citation
into e566040 on develop.

@MellyGray MellyGray marked this pull request as ready for review February 21, 2024 15:26
@MellyGray MellyGray added pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows SPA: File Page Size: 3 A percentage of a sprint. 2.1 hours. integration Tasks involving the connection and interaction of UI features with the Dataverse API labels Feb 21, 2024
@GPortas GPortas self-assigned this Feb 22, 2024
Copy link
Contributor

@GPortas GPortas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good and the feature works as expected.

JSF:
jsffilecitation

SPA:
spafilecitation

@GPortas GPortas merged commit 8a0ee10 into develop Feb 23, 2024
11 of 14 checks passed
@GPortas GPortas deleted the feature/312-integration-file-citation branch February 23, 2024 15:14
jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration Tasks involving the connection and interaction of UI features with the Dataverse API pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours. SPA: File Page
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integrate file citation text
3 participants