wagnerjt / neo4j-apps

Neo4j Desktop Graph App Documentation

Neo4j Desktop Applications

Documentation and Starter Site

Why

This repository is to enable developers, data scientists, or any other user to develop, test, and install neo4j desktop custom applications. For more details, check out the full explanation

Contributing

• This project is work in progress If you would like to contribute, please do get in touch.
• Read Contributing for guidelines
• Any ideas? Create an issue

Documentation

Installation

• Note: if you use npm, you can replace all yarn commands with npm or npm run

git clone https://github.com/wagnerjt/neo4j-apps
cd neo4j-apps
yarn install
yarn start

Visit http://localhost:8000 for the served content, and http://localhost:8000/___graphql for GraphiQL.

The directory structure is broken down in the following way.

contents/docs - All Markdown files
├── get-started
│   ├──  introduction.md
│   └──  why.md
├── react
├── vue
├── angular
src
├── templates - Templates over each markdown
├── anchor.mdx

Edit files in /content/docs and see live updates.

Roadmap

• Improved typings
• Improved responsiveness
• Add Search
• Add Tests
• Add Content

Hosting

You can host this website after it is bundled in any static website hosting provider. In order to host the site, the sites path needs to be altered in gatsby-config.js export object on to the property pathPrefix.

Bundling this website is simply

yarn build

and copy the content of the public folder to the webspace.

We use Github Pages to host this application, so you can alter the github page location, and publish it yourself with

yarn deploy

Forked originally from the gatsby-antd-docs starter. If you like this documentation's style, the maintainer is responsive for contributions :).

License

MIT