{"id":17359336,"url":"https://github.com/himasnhu-at/fastsearch","last_synced_at":"2026-01-06T17:51:35.931Z","repository":{"id":236694269,"uuid":"792992013","full_name":"Himasnhu-AT/FastSearch","owner":"Himasnhu-AT","description":"Google's Search alternative written in rust for creation and usage as a private search engine","archived":false,"fork":false,"pushed_at":"2024-09-24T00:45:23.000Z","size":12145,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T00:12:02.410Z","etag":null,"topics":["development","google","rust","search-engine"],"latest_commit_sha":null,"homepage":"https://dev-fastsearch.vercel.app","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Himasnhu-AT.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-28T05:52:29.000Z","updated_at":"2024-05-21T07:32:14.000Z","dependencies_parsed_at":"2024-05-21T08:46:11.825Z","dependency_job_id":"e1ebb3b2-5eb9-4678-b02d-688886fc802e","html_url":"https://github.com/Himasnhu-AT/FastSearch","commit_stats":null,"previous_names":["himasnhu-at/fastsearch"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Himasnhu-AT%2FFastSearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Himasnhu-AT%2FFastSearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Himasnhu-AT%2FFastSearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Himasnhu-AT%2FFastSearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Himasnhu-AT","download_url":"https://codeload.github.com/Himasnhu-AT/FastSearch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240260721,"owners_count":19773374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["development","google","rust","search-engine"],"created_at":"2024-10-15T19:09:20.884Z","updated_at":"2026-01-06T17:51:35.926Z","avatar_url":"https://github.com/Himasnhu-AT.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FastSearch\n\n\u003e A high-performance, Rust-based search engine for indexing and searching document collections locally.\n\n## Overview\n\nFastSearch is a lightweight, fast search engine implementation whose core is written in Rust. It provides a web interface for easy searching and is designed to index documents from local directories, making it ideal for organizations or individuals who want to search through their own document collections efficiently.\n\nThe engine now uses SQLite as its default storage backend, which provides better performance and scalability compared to the previous JSON-based storage.\n\n![Demo](assets/demo.png)\n\n## Features\n\n- **High Performance**: Core search functionality implemented in Rust\n- **SQLite Backend**: Fast, reliable storage for search indices\n- **Full-Text Search**: TF-IDF based ranking algorithm\n- **Web Interface**: Easy-to-use browser interface for searching\n- **Command-line Tools**: Simple CLI for indexing and searching\n- **Cross-platform**: Works on Windows, macOS, and Linux\n\n## Installation\n\n### Prerequisites\n\n- [Rust](https://www.rust-lang.org/tools/install) (1.56 or later)\n- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) (included with Rust)\n\n### Install from Source\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/Himasnhu-AT/FastSearch.git\n   cd FastSearch\n   ```\n\n2. Make the script executable (Unix/macOS):\n   ```bash\n   chmod +x fast_search.sh\n   ```\n\n## Quick Start\n\n### Indexing Documents\n\nTo index a directory of documents:\n\n```bash\n# On Unix/macOS\n./fast_search.sh index /path/to/documents\n\n# On Windows\nfast_search.bat index C:\\path\\to\\documents\n```\n\nThis will create an `index.db` file in the `packages/engine` directory.\n\n### Running Search Queries\n\nTo search for terms in the indexed documents:\n\n```bash\n# On Unix/macOS\n./fast_search.sh search index.db \"your search query\"\n\n# On Windows\nfast_search.bat search index.db \"your search query\"\n```\n\n### Starting the Web Interface\n\nTo start the web server with a search interface:\n\n```bash\n# On Unix/macOS\n./fast_search.sh serve index.db\n\n# On Windows\nfast_search.bat serve index.db\n```\n\nThen open your browser and go to http://127.0.0.1:6969/\n\n### Cleaning Up\n\nTo remove index files and clean the build:\n\n```bash\n# On Unix/macOS\n./fast_search.sh clean\n\n# On Windows\nfast_search.bat clean\n```\n\n## Advanced Usage\n\n### JSON Storage (Legacy)\n\nIf you prefer to use the legacy JSON storage instead of SQLite:\n\n```bash\n# On Unix/macOS\ncd packages/engine\ncargo run --json index /path/to/documents\n\n# On Windows\ncd packages\\engine\ncargo run --json index C:\\path\\to\\documents\n```\n\n### Custom Server Address\n\nTo run the server on a different address:\n\n```bash\n# On Unix/macOS\n./fast_search.sh serve index.db 192.168.1.100:8080\n\n# On Windows\nfast_search.bat serve index.db 192.168.1.100:8080\n```\n\n## Technical Details\n\nFastSearch uses a Term Frequency-Inverse Document Frequency (TF-IDF) algorithm to rank search results. The search index is stored in a SQLite database, providing fast access and reduced memory usage compared to in-memory or JSON file storage.\n\nFor more technical details, see the [technical documentation](dev-docs/tf_idf.md).\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. To contribute to this repo, follow our [contribution guidelines](dev-docs/contributing.md).\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Changelog\n\nSee [Changelog](dev-docs/changelog.md) for details on recent changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhimasnhu-at%2Ffastsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhimasnhu-at%2Ffastsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhimasnhu-at%2Ffastsearch/lists"}