{"id":21306562,"url":"https://github.com/techmdw/indexing","last_synced_at":"2025-03-15T19:43:33.194Z","repository":{"id":166139270,"uuid":"640536718","full_name":"TechMDW/indexing","owner":"TechMDW","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-19T18:54:41.000Z","size":1071,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-07T06:57:08.526Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TechMDW.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":"2023-05-14T12:27:28.000Z","updated_at":"2023-05-16T19:50:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"d2a7444c-90c3-4508-a322-3414544f4dd7","html_url":"https://github.com/TechMDW/indexing","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechMDW%2Findexing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechMDW%2Findexing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechMDW%2Findexing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechMDW%2Findexing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TechMDW","download_url":"https://codeload.github.com/TechMDW/indexing/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243784099,"owners_count":20347409,"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":[],"created_at":"2024-11-21T16:24:33.452Z","updated_at":"2025-03-15T19:43:33.174Z","avatar_url":"https://github.com/TechMDW.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Indexing\n\nIndexing is a simple search tool that allows users to search for specific content within a given drive or collection of file. It provides a straightforward interface and efficient search algorithms to deliver accurate results quickly.\n\n## Preview\n\n![preview](screenshots/preview.png)\n\n## Features\n\n- **Fast and Efficient Search:** Utilize advanced search algorithms to ensure quick and accurate results.\n- **Flexible Search Queries:** Will support various search query types, such as exact matches, partial matches, and fuzzy searches.\n- **Customizable Search Parameters:** Will Allow users to specify search parameters and filters to narrow down their results.\n- **Scalable and Lightweight:** Designed to handle large datasets while remaining lightweight and resource-friendly.\n\n## Current way of usage\n\n#### Solution 1 (graphical)\n\n**IMPORTANT when using this you will need a c++ compiler for the keybinds\nnote this is subject to change**\n\n1. Clone the repository: `git clone https://github.com/TechMDW/indexing.git`\n2. Navigate to the project directory: `cd indexing`\n3. Run the program: `go run ./cmd/indexing`\n4. use the `ctrl + space` to toggle the search bar if its visible\n\n#### Solution 2 (development, no c++ compiler)\n\n1. Clone the repository: `git clone https://github.com/TechMDW/indexing.git`\n2. Navigate to the project directory: `cd indexing`\n3. Run the program: `go run ./cmd/indexing_dev`\n\n## TODO\n\n- [x] Graceful shutdown\n- [x] Index all drives/files\n- [x] Better error handling on access denied\n- [ ] Improve search algorithm\n- [ ] Filesystem imporvements\n- [ ] Better filter for not indexing certain files\n- [ ] USB version for indexing single drive\n- [ ] Load config file\n- [ ] Darwin (macOS) support\n- [ ] Linux support\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute to Indexing, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch: git checkout -b my-feature-branch.\n3. Make your changes and commit them: git commit -m 'Add some feature'.\n4. Push the changes to your fork: git push origin my-feature-branch.\n5. Submit a pull request detailing your changes.\n\nPlease ensure that your code adheres to the project's coding conventions and that you update relevant documentation as needed.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Contact\n\nIf you have any questions, suggestions, or feedback, please feel free to reach out to us at [contact@techmdw.com].\n\n## Authors\n\n- [JocularMarrow](https://github.com/JocularMarrow)\n- [Simple-MAX](https://github.com/Simple-MAX)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechmdw%2Findexing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechmdw%2Findexing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechmdw%2Findexing/lists"}