starlangsoftware/informationretrieval

Basic Information Retrieval Algorithms and Data Structures

Information Retrieval

Video Lectures

Class Diagram

For Developers

You can also see Python, Cython, C++, Js, C, or C# repository.

Requirements

• Java Development Kit 8 or higher, Open JDK or Oracle JDK
• Maven
• Git

Java

To check if you have a compatible version of Java installed, use the following command:

java -version

If you don't have a compatible version, you can download either Oracle JDK or OpenJDK

Maven

To check if you have Maven installed, use the following command:

mvn --version

To install Maven, you can follow the instructions here.

Git

Install the latest version of Git.

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called InformationRetrieval will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/InformationRetrieval.git

Open project with IntelliJ IDEA

Steps for opening the cloned project:

• Start IDE
• Select File | Open from main menu
• Choose InformationRetrieval/pom.xml file
• Select open as project option
• Couple of seconds, dependencies with Maven will be downloaded.

Compile

From IDE

After being done with the downloading and Maven indexing, select Build Project option from Build menu. After compilation process, user can run InformationRetrieval.

From Console

Go to InformationRetrieval directory and compile with

 mvn compile 

Generating jar files

From IDE

Use package of 'Lifecycle' from maven window on the right and from InformationRetrieval root module.

From Console

Use below line to generate jar file:

 mvn install

Maven Usage

    <dependency>
        <groupId>io.github.starlangsoftware</groupId>
        <artifactId>InformationRetrieval</artifactId>
        <version>1.0.1</version>
    </dependency>