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

Request for NodeJS Client Development for Hydroshare's hsclient #55

Open
muhammedyusuf-sermet opened this issue Jun 11, 2023 · 1 comment
Labels
question Further information is requested

Comments

@muhammedyusuf-sermet
Copy link

Description

I would like to request the development of a NodeJS client to expand the reach and compatibility of the Hydroshare platform. This would allow developers who prefer working with NodeJS and JavaScript to easily interact with Hydroshare's API and resources.

Justification

NodeJS has grown significantly in popularity and has become a widely used server-side technology for web-app development. Its event-driven architecture, performance, scalability, and the ability to use JavaScript on both the client and server-side make it an attractive choice for many developers (source).

By creating a NodeJS client, Hydroshare would be able to cater to an even larger audience of developers and expand the reach of the platform. Additionally, the non-blocking, asynchronous nature of NodeJS could provide performance benefits when working with real-time data transmission and frequent interactions with the Hydroshare web server.

Proposal

I propose the development of a NodeJS client for Hydroshare, which would include:

  • Implementing the core functionalities and API calls currently available in the hsclient Python package.
  • Ensuring compatibility with existing Hydroshare resources, data structures, and workflows.
  • Providing clear documentation and code examples to help developers get started with using the NodeJS client.
@devincowan
Copy link
Collaborator

Thanks @muhammedyusuf-sermet for this suggestion
We would love to learn more about your particular use case if you're willing to provide details.

As it sounds like you are aware, HydroShare has a public REST API. This has been developed with the intent of enabling many of the functions that are accessible through the web user interface, to be done programmatically. We are making our best effort to comply with OpenAPI standards. The API is documented at https://www.hydroshare.org/hsapi/

@devincowan devincowan added the question Further information is requested label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants