A distributed, index based, search engine.

github

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• JDK >= 8.x
• Maven

Installing

1. Install dependencies

   mvn install
   

2. Run the server

   mvn jetty:run
   

You can now connect to the API at http://localhost/api/test

Running the tests

JUnit is used for the tests. You can run it with Maven:

mvn test

Deployment

not deployable yet...

Documentation

API

The API documentation can be found here.

Built With

• Maven - Dependency Management
• Jetty - HTTP Server
• JBoss RestEasy - RestFull Framework
• swagger-maven-plugin - OpenApi doc generation
• swagger-ui - Web view for the API documentation

Authors

• Sylvain JOUBE - SylvainLune
• Etienne LELOUËT - etienne-lelouet
• Nicolas PEUGNET - n-peugnet

See also the list of contributors who participated in this project.