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

Update documentation #5

Merged
merged 1 commit into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/modules/ROOT/images/neo4j-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/modules/ROOT/pages/internals/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,31 @@ We will not have any TypeDoc documentation, because the TypeScript version used
== Component Diagram (WIP)

image:neo4j-browser.png[width=300]

* Sentry.io is initialized in the top index.tsx
* AppInit.tsx is responsible for several initializations:
+
--
** Redux
** Suber: The reason suber is used is sharing states between Neo4J database data and React components is not supported
by Redux. As its doc (https://github.com/oskarhane/suber#in-combination-with-redux) points out, Redux is for two-way
communications between components. Suber is for one-way comm. between component and DB.
** Apollo GraphQL Client
** Drag & Drop Plugin
--
+
The initialization assumes provider pattern around regular App component:
[source,typescript]
----
<Provider store={store as any}>
<BusProvider bus={bus}>
<ApolloProvider client={client}>
<DndProvider backend={HTML5Backend}>
<App />
</DndProvider>
</ApolloProvider>
</BusProvider>
</Provider>
----

* Neo4J Browser styling is implemented via https://styled-components.com/[styled-components] and is initialized in App.tsx