<commit_before>## BudgetKey Search App

This is the search interface budgetkey app.

It currently can be accessed at [next.obudget.org/app/search](next.obudget.org/app/search).

**Basic functionality:**

- It allows users to type in a free text query and get results from the Budget Key database.
- Results are received from the Search API.
- Results can be filtered by kind and time range.
- Results link to other parts of the web site.

Design mockups can be seen in issue [#1](https://github.com/OpenBudget/budgetkey-app-search/issues/1).
<commit_msg>Link to main documentation<commit_after>## BudgetKey Search App

This is the search interface budgetkey app.

It currently can be accessed at [next.obudget.org/app/search](next.obudget.org/app/search).

**Basic functionality:**

- It allows users to type in a free text query and get results from the Budget Key database.
- Results are received from the Search API.
- Results can be filtered by kind and time range.
- Results link to other parts of the web site.

Design mockups can be seen in issue [#1](https://github.com/OpenBudget/budgetkey-app-search/issues/1).

Before starting, take a peek in our [documentation](https://github.com/OpenBudget/BudgetKey/blob/master/README.md)
{'fraction_non_alphanumeric': 0.08980582524271845, 'fraction_numerical': 0.003236245954692557, 'mean_word_length': 4.219409282700422, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6755185', 'n_tokens_mistral': 358, 'n_tokens_neox': 348, 'n_words': 153}