# Hulipaa - Open Source Search for Static Websites

Hulipaa is a simple search engine designed to be used in a static website.

Hulipaa is light but scalable, it can index tens of thousands of pages with no impact to the browser.

The search engine generates and indexes all the results when the website is built, using the same strategy of websites generators.  
This means you don't need a back-end server running.

## Demo
You can see the library in action in our [Demo Website](https://sambuccid.codeberg.page/hulipaa-demo/).

![demo website](/images/search_page_with_results.png)

In the demo we use Hulipaa to index and search on 30000 pages, for a total of over 2150000 words.

You can also find the code of the Demo in the [Repository](https://codeberg.org/sambuccid/hulipaa-demo).

## How to use
Follow the [Hulipaa tutorial](tutorial.md) to setup and use the library.

Hulipaa is released using npm: [Hulipaa](https://www.npmjs.com/package/hulipaa) | [Hulipaa-ui](https://www.npmjs.com/package/hulipaa-ui)

Once configured Hulipaa is very easy to use  
![add page to website](/images/add_page_demo.gif)

## Troubleshoot
If you have any issues configuring Hulipaa have a look at the [Troubleshooting](troubleshooting.md) page.