PHPackages                             keiro/php-js-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. keiro/php-js-search

ActiveLibrary

keiro/php-js-search
===================

A client or server side search engine for use on static pages.

1.1.1(6y ago)112MITHTMLPHP >=5.6.0

Since Apr 25Pushed 6y agoCompare

[ Source](https://github.com/Keirodev/search-engine-php-js)[ Packagist](https://packagist.org/packages/keiro/php-js-search)[ RSS](/packages/keiro-php-js-search/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependenciesVersions (11)Used By (0)

js-search
=========

[](#js-search)

This is a client side search engine for use on static pages.

It uses a pre-compiled search index to add a fulltext search to static HTML pages such as [github pages](https://pages.github.com/) or offline API documentation. The index is built by a PHP script using a similar yet much more simplified and dump approach than the popular search engine [Lucene](http://lucene.apache.org/).

To see how it looks like, check out the [demo](http://cebe.github.io/js-search/#demo).

Installation
------------

[](#installation)

PHP 5.6 or higher is required to run the index generator.

Installation is recommended to be done via [composer](https://getcomposer.org/) by adding the following to the `require` section in your `composer.json`:

```
{ "require" :
  {
  "keiro/php-js-search": "~1.0"
  }
}
```

Alternatively run `composer require "keiro/php-js-search"`.

Generate the index
------------------

[](#generate-the-index)

Using the command line tool:

```
vendor/bin/generateindex

```

#### js

[](#js)

This will generate a `jssearch.index.js` file that you have to include in the HTML header.

#### php

[](#php)

This will generate a `search-engine-index.php` in data folder. Example to generate php sqlite index :

```
vendor/bin/generateindex tests/ -l php -db
```

Usage
-----

[](#usage)

See [example.html](example.html) for a js implementation.
See [example-php.html](example-php.html) for a php implementation. Notice that the `phpsearch.php` file act as an endpoint. Feel free to integrate its logic in your own framework.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~229 days

Recently: every ~3 days

Total

10

Last Release

2338d ago

Major Versions

0.9.3 → 1.02019-12-08

PHP version history (2 changes)0.9.0PHP >=5.4.0

1.0PHP >=5.6.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/9025376?v=4)[Kévin Monteiro](/maintainers/Keirodev)[@Keirodev](https://github.com/Keirodev)

---

Top Contributors

[![Keirodev](https://avatars.githubusercontent.com/u/9025376?v=4)](https://github.com/Keirodev "Keirodev (19 commits)")[![cebe](https://avatars.githubusercontent.com/u/189796?v=4)](https://github.com/cebe "cebe (17 commits)")[![bigmacfoobar](https://avatars.githubusercontent.com/u/6537154?v=4)](https://github.com/bigmacfoobar "bigmacfoobar (1 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (1 commits)")

### Embed Badge

![Health badge](/badges/keiro-php-js-search/health.svg)

```
[![Health](https://phpackages.com/badges/keiro-php-js-search/health.svg)](https://phpackages.com/packages/keiro-php-js-search)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)