https://github.com/apache/lucene

Apache Lucene open-source search software
https://github.com/apache/lucene

backend information-retrieval java lucene nosql search search-engine

Last synced: 2 days ago
JSON representation

Apache Lucene open-source search software

• Host: GitHub
• URL: https://github.com/apache/lucene
• Owner: apache
• License: apache-2.0
• Created: 2021-02-23T17:16:56.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T13:35:11.000Z (6 days ago)
• Last Synced: 2024-12-06T13:38:44.800Z (6 days ago)
• Topics: backend, information-retrieval, java, lucene, nosql, search, search-engine
• Language: Java
• Homepage: https://lucene.apache.org/
• Size: 488 MB
• Stars: 2,739
• Watchers: 87
• Forks: 1,046
• Open Issues: 2,333
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-distributed-system-projects - Apache Lucene - a high-performance, full featured text search engine library

README

        


# Apache Lucene

![Lucene Logo](https://lucene.apache.org/theme/images/lucene/lucene_logo_green_300.png?v=0e493d7a)

Apache Lucene is a high-performance, full-featured text search engine library

written in Java.

[![Build Status](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/badge/icon?subject=Lucene)](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/)

[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.apache.org/scans?search.buildToolType=gradle&search.rootProjectNames=lucene-root)

## Online Documentation

This README file only contains basic setup instructions.  For more

comprehensive documentation, visit:

- Latest Releases: 

- Nightly: 

- New contributors should start by reading [Contributing Guide](./CONTRIBUTING.md)

- Build System Documentation: [help/](./help/)

- Migration Guide: [lucene/MIGRATE.md](./lucene/MIGRATE.md)

## Building

### Basic steps:

  

1. Install OpenJDK 21.

2. Clone Lucene's git repository (or download the source distribution).

3. Run gradle launcher script (`gradlew`).

We'll assume that you know how to get and set up the JDK - if you don't, then we suggest starting at https://jdk.java.net/ and learning more about Java, before returning to this README.

## Contributing

Bug fixes, improvements and new features are always welcome!

Please review the [Contributing to Lucene

Guide](./CONTRIBUTING.md) for information on

contributing.

- Additional Developer Documentation: [dev-docs/](./dev-docs/)

## Discussion and Support

- [Users Mailing List](https://lucene.apache.org/core/discussion.html#java-user-list-java-userluceneapacheorg)

- [Developers Mailing List](https://lucene.apache.org/core/discussion.html#developer-lists)

- IRC: `#lucene` and `#lucene-dev` on freenode.net