Git Product home page Git Product logo

graph-app-kit's Introduction

Graph App Kit

Build Neo4j Graph Apps using components and utilities from this graph app kit.
This kit should be considered to be 'under development' and the components in it can have breaking changes (i.e. until version 1.0.0 semver does not apply).

Browse source code and read README:s in sub directories for examples and docs.

What's in here (so far)

User interface components

Component Description
<Render> A declarative toggling component to mount / unmount child components under certain conditions.
<AsciiTable> Render your data in an text/ascii table with fixed width font.

Utility components

Component Description
<Cypher> A simple component to execute a Cypher query and return the result to your render function.
<DesktopIntegration> Easy integration for your app into the Neo4j Desktop API. Subscribe to events etc.
<DriverProvider> Provide your React application with a neo4j-driver in application context.

Install and import

npm install graph-app-kit --registry https://neo.jfrog.io/neo/api/npm/npm
// or
yarn add graph-app-kit --registry https://neo.jfrog.io/neo/api/npm/npm
import { Cypher, DriverProvider } from 'graph-app-kit/utils'
import { Render } from 'graph-app-kit/ui'

Component playground / library

There's an interactive playground to view and modify the components.
This is temporarily hosted at https://styleguide-oipiezsosg.now.sh.
Feedback wanted!

To use the playground when developing components: yarn playground and to generate a static version to deploy: yarn playground:build (the artifacts end up in styleguide/)

Development mode

git clone [email protected]:neo4j-contrib/graph-app-kit.git graph-app-kit
cd graph-app-kit
yarn install

Linting

yarn lint

Testing

Single run:

yarn test

Continous testing (watch mode):

yarn dev

graph-app-kit's People

Contributors

oskarhane avatar pe4cey avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.