graph-explorer icon indicating copy to clipboard operation
graph-explorer copied to clipboard

[Feature Request] Distribute Graph Explorer static website as a React library (e.g. via NPM)

Open JeeZeh opened this issue 1 year ago • 1 comments

Community Note

  • Please use a 👍 reaction to provide a +1/vote. This helps the community and maintainers prioritize this request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Is your feature request related to a problem? Please describe. It is not currently possible (?) to host the Graph Explorer website/UI as part of another static website. For folks who already have a deployment of some sort of static website, it would be preferred to re-use the existing deployment, allowing the Graph Explorer to be accessed via some route of their application.

For example, in our setup we already have infrastructure for protecting access to the website, as well as making calls to APIs (that could be used to forward requests to the Neptune). It would be significantly easier for us to use the Graph Explorer if it could be treated as an importable React component/module.

Describe the solution you'd like In an ideal world, the graph explorer would be an NPM module that can be hosted inside any other React application, e.g.

Install the module: npm i -s @aws/graph-explorer-website

Add the component to your application, e.g. as route on a different path:

import { GraphExplorer } from "@aws/graph-explorer-website"

<Routes> 
     <Route path="/" element={<MyApp/>}/>
     <Route path="/explorer" element={<GraphExplorer config={config} />}/>
</Routes>

JeeZeh avatar May 15 '23 13:05 JeeZeh

I have a similar use case but I am interested in using only Graph component not the whole website. If specific component can be made available as library then it would be more useful.

akashg90 avatar Jun 06 '23 20:06 akashg90

@akashg90 The graph visualization library is already available. We use Cytoscape.

kmcginnes avatar May 22 '24 16:05 kmcginnes

Unfortunately, this feature request does not align with our goals for Graph Explorer. The app itself will remain a separate required deployment that you can link to from other apps.

This does not mean we are shutting the door on having reusable components in the future that you might be able to add to other apps.

kmcginnes avatar May 22 '24 16:05 kmcginnes

FYI, this feature request is being tracked by the roadmap item:

  • #695

kmcginnes avatar Dec 10 '24 15:12 kmcginnes