ACT Platform is now called grafeo!

Grafeo is a versatile platform to create custom data models, collect and share knowledge. It is a flexible, well-rounded solution that can be used for any purpose. Developed as part of the ACT research project, it remains at the core of ACT and powers the ACT backend. Learn more about ACT here.

Usage

Grafeo exposes a set of REST APIs. See this guideline on how to work with the API.

Installation

Prerequisites

• Java 17 or newer for running the application.
• Maven for managing dependencies, building the code, running the unit tests, etc.
• An installation of Apache Cassandra for storage. Any version of Apache Cassandra 3.x or 4.x is supported.
• An installation of Elasticsearch for indexing. Version 7.17 of Elasticsearch is required.
• (Optional) An installation of ActiveMQ for the multi-node environment.
• (Optional) An installation of Apache Kafka for data centre replication.
• (Optional) An installation of Docker for running the integration tests.

Compilation

• Execute mvn clean install -DskipTests from the repository's root folder to compile the code.
• Afterwards follow the deployment guide to run the application.

Testing

• Download a Cassandra image by docker pull cassandra.
• Download an Elasticsearch image by docker pull docker.elastic.co/elasticsearch/elasticsearch:7.17.13.
• Download an ActiveMQ image by docker pull webcenter/activemq.
• Execute mvn clean install for running all tests including integration tests.
• Execute mvn clean install -DskipSlowTests for skipping the integration tests.
• By default the integration tests will try to connect to Docker on localhost and port 2375. Set the $DOCKER_HOST environment variable to override this behaviour.

Known issues

See Issues.

Contributing

See the CONTRIBUTING.md file.

License

Grafeo is released under the ISC License. See the bundled LICENSE file for details.