Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Graph Application Platform based on Neo4j
Java JavaScript HTML CSS Shell Python Other

README.md

The Structr Project

Build Status

Structr (pronounce it like 'structure') is a Java framework for mobile and web applications based on the graph database Neo4j. It was designed to simplify the creation of complex graph database applications by providing a comprehensive Java API and a set of features common to most use cases. This enables developers to build a sophisticated web or mobile app based on Neo4j within hours.

Structr was awarded with the Graphie Award (by Neo4j maker Neo Technology) for the Most Innovative Open Source Graph Application in 2012.

Quick Start

Build and run Structr from the source code.

Prerequisites are the Java JDK 1.7, Maven 3.0.4+ and git.

Verify the java/maven version with mvn -v, then do:

git clone https://github.com/structr/structr.git

cd structr
mvn clean install -DskipTests
cd structr-ui

mvn validate exec:exec

Login with the credentials admin/admin at:

http://localhost:8082/structr/

For documentation, please take a look here:

http://docs.structr.org

Getting Started

A very simple CMS demo app, hands-on tutorial:

A Structr Demo Application in Less Than Ten Minutes: https://structr.org/blog/structr-demo-in-ten-minutes

Using Apache Maven archetypes, you get a demo project up and running in 5 minutes.

  • See the screencast for a short introduction to the maven archetype and a small feature demo.
  • See the structr-android-client project on github for more information on how to use structr as a mobile backend.

Components

To get an overview of the components, just browse the source code and review the READMEs.

Name Description Documentation
structr-core The Structr Server (Neo4j, OGM, ...) docs
structr-rest The REST server (add-on to structr-core) docs
structr-ui The Structr UI (add-on to structr-rest) docs

Structr UI is a browser based frontend for Visual Schema Design, CRUD operations and basic CMS functionalitiy, e.g. for handling pages, files, images, users/groups.

Google Group / Mailing List

For non-technical questions about Structr, Structr's licensing, use-cases etc. please use the Structr Google Group or send an e-mail to structr@googlegroups.com.

Report Bugs

You can submit issues (bugs, feature requests etc.) on the issue-tracker.

Contribute

For more information on how to contribute, please see Contribute to Structr.

Commercial Services

https://structr.org/services

Structr Hosting

https://structr.com

Learn More

Initial Authors

Copyright and License

Copyright 2010-2015 Morgner UG (haftungsbeschränkt)

Structr is licensed under the GPLv3 and AGPLv3 (Structr UI).

Something went wrong with that request. Please try again.