https://github.com/ahmed-ashraff/vdora
Basic text search engine based on the classical Vector Space Model.
https://github.com/ahmed-ashraff/vdora
information-retrieval java search-engine vector-model
Last synced: 11 months ago
JSON representation
Basic text search engine based on the classical Vector Space Model.
- Host: GitHub
- URL: https://github.com/ahmed-ashraff/vdora
- Owner: ahmed-ashraff
- License: apache-2.0
- Created: 2025-05-04T10:23:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T17:07:45.000Z (about 1 year ago)
- Last Synced: 2025-06-25T17:42:49.282Z (12 months ago)
- Topics: information-retrieval, java, search-engine, vector-model
- Language: Java
- Homepage:
- Size: 2.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vdora
**Vdora** is a basic text search engine built on the classical **Vector Space Model**, featuring a client with a read-evaluate-print loop (REPL) interface for interactive document search using cosine similarity ranking.
---
## Installation Requirements
Before building or running this project, ensure your system has the following installed:
### 1. Java Development Kit (JDK)
You need **Java 21** or later.
- **Windows/Linux/macOS**: Download from [Adoptium](https://adoptium.net/) or install via your OS package manager.
### 2. Maven
Vdora uses **Apache Maven** for build configuration and dependency management.
- **Windows**: Install via [Chocolatey](https://chocolatey.org/) → `choco install maven`
- **Linux**:
- Debian/Ubuntu: `sudo apt install maven`
- Fedora: `sudo dnf install maven`
- Or download from [Maven’s official site](https://maven.apache.org/).
---
## Build and Run
### 1. Clone the repository
```bash
git clone https://github.com/ahmed-ashraff/vdora
```
### 2. Build the project
```bash
cd vdora
mvn exec:java
```
## License
This project is released under the Apache License 2.0
## Code Style
This project follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).