-
Notifications
You must be signed in to change notification settings - Fork 37
Project Structure
The RRE repository has been structured as an Apache Maven multi-module project, which consists of the modules listed below. Beside each of them, there's a link to a dedicated Wiki page, where you can find detailed information.
-
rre
- rre-core: the core libraries, where all the magic happens
-
rre-maven-archetypes: see Maven Archetypes
- rre-maven-elasticsearch-archetype: archetype for Elasticsearch-based projects
- rre-maven-external-elasticsearch-archetype: archetype for externally running Elasticsearch-based projects
- rre-maven-solr-archetype: archetype for Apache Solr-based projects
- rre-maven-external-solr-archetype: archetype for externally running Solr-based projects
- rre-maven-generic-search-archtype: archetype for a custom search API w your own Adapter
-
rre-maven-plugin: see Maven Plugin
- rre-maven-elasticsearch-plugin: plugin for Elasticsearch-based projects
- rre-maven-external-elasticsearch-plugin: plugin for externally running Elasticsearch-based projects
- rre-maven-solr-plugin: plugin for Apache Solr-based projects
- rre-maven-external-solr-plugin: plugin for externally running Solr-based projects
- rre-maven-generic-search-plugin: plugin for a custom search API w your own Adapter
- rre-maven-report-plugin: see Maven Reporting Plugin
-
rre-search-platform: see Search Platform Framework
- rre-search-platform-api: search platform abstraction layer
- rre-search-platform-elastic-impl: Elasticsearch binding
- rre-search-platform-solr-impl: Apache Solr binding
- rre-search-platform-external-solr-impl: External Solr binding
- rre-server: see RRE Server
Being a Maven project, in case you would like to contribute, it's very easy to load the whole project into your favorite IDE. However, in case you run in some trouble please contact us, we will be happy to help you.
1. What is it?
2. Quick Start
3. Project Structure
4. Evaluation Measures
5. How does it work?
5.1 Domain Model
5.2 What we need to provide
5.3 Where we need to provide
5.4 The Evaluation Process
5.5 The Evaluation Output
5.6 Persisting evaluation outputs
6. RRE Server
7. Apache Maven
7.1 Maven Plugin
7.2 Maven Reporting Plugin
7.3 Maven Archetype
8. Search Platform Framework
8.1 Supported platforms
8.2 Customising the Search Platform
9. FAQ