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

Analyze js-dataverse module and decide whether to build on top of it or redo it from scratch #13

Closed
GPortas opened this issue Mar 7, 2023 · 1 comment
Assignees
Labels
D: API connectivity Deliverable: API connectivity MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-1.7.1 NIH, yr1, aim7, task1: Research & architecture for separating backend and frontend Size: 30 A percentage of a sprint. 21 hours. (formerly size:33)

Comments

@GPortas
Copy link
Contributor

GPortas commented Mar 7, 2023

Overview of the Feature Request

Since the early discussions about modularity in the Dataverse SPA, we suggested the idea of creating a Dataverse API Client module / library, which would encapsulate the Dataverse API access logic so that it can be reused by other applications other than the Dataverse SPA.

Currently there is already an npm module for this: https://www.npmjs.com/package/js-dataverse.
Actually, this module is not heavily used and is a bit old. We need to analyze it in more detail to decide whether to build on top of it and continue its evolution, or redo it from scratch considering the design and functionality that the module already provides.

What kind of user is the feature intended for?

Dataverse frontend developers

What inspired the request?

  • MVP Strategy document: link
  • New potential issues requiring connectivity to the Dataverse API

What existing behavior do you want changed?

N/A

Any brand new behavior do you want to add to Dataverse Frontend?

  • API Client / Data Access Layer

Any related open or closed issues to this feature request?

@GPortas GPortas added D: API connectivity Deliverable: API connectivity Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) labels Mar 14, 2023
@mreekie mreekie added this to This Sprint 🏃‍♀️ 🏃 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Mar 15, 2023
@mreekie mreekie added the pm.GREI-d-1.7.1 NIH, yr1, aim7, task1: Research & architecture for separating backend and frontend label Mar 20, 2023
@GPortas GPortas self-assigned this Mar 20, 2023
@GPortas GPortas moved this from This Sprint 🏃‍♀️ 🏃 to IQSS Team - In Progress 💻 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Mar 20, 2023
@GPortas
Copy link
Contributor Author

GPortas commented Mar 27, 2023

After analyzing the js-dataverse package, the final decision is to reimplement the package from scratch. For more information, see: Analysis document

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D: API connectivity Deliverable: API connectivity MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-1.7.1 NIH, yr1, aim7, task1: Research & architecture for separating backend and frontend Size: 30 A percentage of a sprint. 21 hours. (formerly size:33)
Projects
Status: No status
Development

No branches or pull requests

2 participants