Skip to content

OpenDgraph/neoRatel

This branch is 24 commits ahead of dgraph-io/neoRatel:main.

Folders and files

NameName
Last commit message
Last commit date
Mar 12, 2025
Mar 12, 2025
May 16, 2023
May 9, 2023
Sep 27, 2023
Mar 3, 2025
Jun 11, 2024
Mar 2, 2025
May 9, 2023
Mar 3, 2025
Mar 3, 2025
May 9, 2023
May 9, 2023
May 12, 2023

Repository files navigation

neoRatel

UI tool for Dgraph Developers. It is inspired by the existing functionalities of Ratel.

Get started

  • clone the repository
  • npm install to install dependencies
  • npm run dev to start a local server

Debugging

  • npm run debug to start a local server in debug mode
  • Go to Debug tab in VsCode and run the debug tool

Use cases

Application Developers can

  • connect to Dgraph cluster on-prem or in Cloud

    • providing an API key (cloud only)
    • providing a user/password (on-prem or cloud with ACL)
    • providing a security token (on-prem with --security option)
  • execute a DQL query and

    • see the result as JSON
    • see the result as Graph
    • see the result as Chart
    • see the result as markers on a map
  • execute a DQL mutation

  • build a DQL query using an graphical editor

  • execute a GraphQL query and

    • see the result as JSON
    • see the result as Graph
    • see the result as Chart
    • see the result as markers on a map
  • execute a GraphQL mutation

  • build a GraphQL query or mutation using an graphical editor

  • Manage DQL Schema:

    • create a DQL Schema
    • update DQL predicate definition (type and indexes)
    • Drop the DQL schema and all data
    • remove a predicate and drop associated data
  • Manage Dgraph data:

    • see the number of nodes having a specific predicate
    • Drop all data
    • Drop data related to a predicate

Technical stack

One of the motivation for this project is to have a UI tool for Application developers interacting with Dgraph, based on a recent technology stack, with few dependencies and easy to maintain.

The current stack is using

  • zustand
  • Vite

Technical tasks

  • Create a new project from scratch
  • Use Vite instead of create react app
  • Use zustand instead of Redux
  • Organize the project in a better way
  • Create charts - Export results from Zustand to the chart.
  • Create a Proxy to handle cluster the requests
  • Create a binary to run the build
  • Create a Docker compose
  • Create a CI/CD
  • Create an exporter handler (RDF, JSON, CSV, etc)
  • Create a schema builder
  • Create a schema editor
  • Create a schema viewer (As graphs, maybe it should be a builder, editor and viewer in one)
  • Create a GraphQL handler/helper
  • Create a Admin UI
  • Create a Query builder with UI(in blocks)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.9%
  • CSS 7.7%
  • Other 1.4%