From 4868c6f0e32d20c2f7000b701c32baa9ca873f53 Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Mon, 7 Nov 2016 15:46:40 -0500 Subject: [PATCH] Adding a style for the site and a index page. --- src/site/markdown/index.md | 94 ++++++++++++++++++++++++++++++++++++++ src/site/site.xml | 69 ++++++++++++++++++++++++++++ 2 files changed, 163 insertions(+) create mode 100644 src/site/markdown/index.md create mode 100644 src/site/site.xml diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md new file mode 100644 index 00000000..33414483 --- /dev/null +++ b/src/site/markdown/index.md @@ -0,0 +1,94 @@ + + +An ORM / OGM for the TinkerPop graph stack. + +**Licensed under the Apache Software License v2** + +The Ferma project was originally created as an alternative to the +TinkerPop2 Frames project. Which at the time lacked features needed by +the community, and its performance was cripplingly slow. Today Ferma is +a robust framework that takes on a role similar to an Object-relational +Model (ORM) library for traditional databases. Ferma is often referred +to as a Object-graph Model (OGM) library, and maps Java objects to +elements in a graph such as a Vertex or an Edges. In short it allows a +schema to be defined using java interfaces and classes which provides a +level of abstraction for interacting with the underlying graph. + +Ferma 3.x **Supports TinkerPop3**. For tinkerPop2 support use Ferma +version 2.x. + +Annotated classes in Ferma have their abstract methods implemented using +code generation during start-up with Byte Buddy, avoiding the need for +proxy classes. This in turn significantly improves performance when +compared with TinkerPop Frames and other frameworks. Ferma offers many +features including several annotation types to reduce the need for +boilerplate code as well as handling Java typing transparently. This +ensures whatever the type of the object is when you persist it to the +graph the same Java type will be used when instantiating a class off of +the graph. + +Ferma is designed to easily replace TinkerPop Frames in existing code, +as such, the annotations provided by Ferma are a super-set of those +provided by TinkerPop Frames. + +Ferma is built directly on top of TinkerPop and allows access to all of +the internals. This ensures all the TinkerPop features are available to +the end-user. The TinkerPop stack provides several tools which can be +used to work with the Ferma engine. + +- **Gremlin**, a database agnostic query language for Graph Databases. +- **Gremlin Server**, a server that provides an interface for + executing Gremlin on remote machines. +- a data-flow framework for splitting, merging, filtering, and + transforming of data +- **Graph Computer**, a framework for running algorithms against a + Graph Database. +- Support for both **OLTP** and **OLAP** engines. +- **TinkerGraph** a Graph Database and the reference implementation + for TinkerPop. +- Native **Gephi** integration for visualizing graphs. +- Interfaces for most major Graph Compute Engines including **Hadoop + M/R**. **Spark**, and **Giraph**. + +Ferma also supports any of the many databases compatible with TinkerPop +including the following. + +- [Titan](http://thinkaurelius.github.io/titan/) +- [Neo4j](http://neo4j.com) +- [OrientDB](http://www.orientechnologies.com/orientdb/) +- [MongoDB](http://www.mongodb.org) +- [Oracle + NoSQL](http://www.oracle.com/us/products/database/nosql/overview/index.html) +- TinkerGraph + +Ferma Javadocs: +[latest](http://www.javadoc.io/doc/com.syncleus.ferma/ferma) - +[3.0.1](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/3.0.1) - +[3.0.0](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/3.0.0) - +[2.2.0](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.2.0) - +[2.1.0](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.1.0) - +[2.0.6](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.6) - +[2.0.5](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.5) - +[2.0.4](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.4) - +[2.0.3](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.3) - +[2.0.2](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.2) - +[2.0.1](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.1) - +[2.0.0](http://www.javadoc.io/doc/com.syncleus.ferma/ferma/2.0.0) + +For support please use +[Gitter](https://gitter.im/Syncleus/Ferma) +or the [official Ferma mailing +list](https://groups.google.com/a/syncleus.com/forum/#!forum/ferma-list). + +Please file bugs and feature requests on +[Github](https://github.com/Syncleus/Ferma/issues). + +Obtaining the Source +-------------------- + +The official source repository for Ferma is located in the Syncleus +Github repository and can be cloned using the following command. + +``` +git clone https://github.com/Syncleus/Ferma.git +``` diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 00000000..95c9fbdf --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<project name="Maven"> + <bannerLeft> + <name>Ferma</name> + <src>http://syncleus.com/Ferma/images/ferma-logo-text.png</src> + <href>http://Syncleus.com/Ferma</href> + </bannerLeft> + <bannerRight> + <src>http://syncleus.com/img/intro-logo.png</src> + </bannerRight> + <body> + <links> + <item name="Syncleus" href="http://Syncleus.com/"/> + </links> + + <menu name="Overview"> + <item name="Introduction" href="index.md"/> + </menu> + + <menu ref="reports"/> + + </body> + + <skin> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-maven-skin</artifactId> + <version>1.1.1</version> + </skin> + + <custom> + <reflowSkin> + <theme>bootswatch-spacelab</theme> + <highlightJs>true</highlightJs> + <brand> + <name>Ferma</name> + <href>https://github.com/Syncleus/Ferma</href> + </brand> + <slogan>Super interesting project doing good things.</slogan> + <titleTemplate>%2$s | %1$s</titleTemplate> + <toc>top</toc> + <topNav>Download|reports</topNav> + <bottomNav> + <column>Main|Download</column> + <column>Documentation</column> + <column>reports|modules</column> + </bottomNav> + <bottomDescription> + This is a very good project doing interesting and valuable things. + </bottomDescription> + <pages> + <index project="project-id"> + <shortTitle>Welcome</shortTitle> + <breadcrumbs>false</breadcrumbs> + <toc>false</toc> + <sections> + <carousel /> + <body /> + <sidebar /> + <thumbs>2</thumbs> + <columns>3</columns> + </sections> + </index> + <developer-info> + <toc>sidebar</toc> + </developer-info> + </pages> + </reflowSkin> + </custom> +</project> -- GitLab