Hilly Fields Technical College

This branch contains the embedded version of the Hilly Fields Technical College web application.

There are several branches that you may find useful:

master[THIS BRANCH] - contains the bolt version of this application. It requires Neo4j 3.0 or above.
embedded - contains the embedded version of this application. It requires Neo4j 2.3 or above.
http - contains the http version of this application. It requires Neo4j 2.3 or above.

Overview

This demo web application shows developers how to quickly get started with the Neo4j OGM library and Neo4j graph database. For the Spring Framework version of this application please check out SDN4 University.

Hilly Fields Technical College is a fictitious educational institution. This application allows you to manage its departments, teaching staff, subjects, students and classes.

This project is built using:

Neo4j OGM 2.1
AngularJS 1.3
Bootstrap 3.3
Ratpack 1.4

It leverages the power of the Neo4j Object Graph Mapper(OGM) to via a RESTful interface with which a web client application may interact. The application is entirely stateless: every interaction involves a call over the wire to a Neo4j server.

Getting Started

Prerequisites

You will need to following to run this application:

Gradle has already been downloaded for you to execute.

Download the application

Either download the application or use git to clone the application:

git clone git@github.com:neo4j-examples/neo4j-ogm-university.git
cd neo4j-ogm-university

The static resources defined in the bower.json file will be installed under the src/ratpack/public/bower_components directory. This directory is ignored by git.

Starting the application

You'll need to provide connection credentials for the database. To do this is to set the Neo4j username and password in src/main/resources/ogm.properties

driver=org.neo4j.ogm.drivers.bolt.driver.BoltDriver
URI=bolt://localhost
username=<Your username here>
password=<Your password here>

You can then start the application with gradle:

gradlew run

And that's it! Head to http://localhost:5050 to see your application running.

Loading the initial dataset

WARNING!

By default, the application will attempt to use a Neo4j instance running on the same machine as this application started on the standard port 7474. IT WILL DESTROY ALL THE DATA IN THAT DATABASE AT STARTUP. So if you don't want that to happen please back up any existing database first.

You may notice that there is no data for you to interact with. To fix this hit the following endpoint from your browser or using curl:

http://localhost:5050/api/reload

This will pre-load the Neo4j database with a handful of departments, a dozen or so subjects and teachers, and 200 students. You'll probably want to enrol them in classes...

Stopping the application server

You can stop the application server at any time by pressing Ctrl-C in the console window from where you launched it.

Make it better!

If you'd like to contribute to the development of this application you will need to install:

NodeJS
Bower

The install bower via:

npm install --global bower

Development mode is on by default in Ratpack so you can just hit refresh to see the changes in the application.

nmervaillie/neo4j-ogm-university