{"id":22353205,"url":"https://github.com/joelseq/surreal-search","last_synced_at":"2025-03-26T12:21:08.354Z","repository":{"id":204076124,"uuid":"711058139","full_name":"joelseq/surreal-search","owner":"joelseq","description":"Unofficial search engine for the SurrealDB documentation","archived":false,"fork":false,"pushed_at":"2023-10-28T19:16:51.000Z","size":200,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T13:24:55.482Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joelseq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-10-28T05:00:26.000Z","updated_at":"2023-11-18T09:27:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"f3a7b620-0e51-4b0d-b764-34c5e0557caa","html_url":"https://github.com/joelseq/surreal-search","commit_stats":null,"previous_names":["joelseq/surreal-search"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelseq%2Fsurreal-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelseq%2Fsurreal-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelseq%2Fsurreal-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelseq%2Fsurreal-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joelseq","download_url":"https://codeload.github.com/joelseq/surreal-search/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245650459,"owners_count":20650105,"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-12-04T12:34:38.052Z","updated_at":"2025-03-26T12:21:08.331Z","avatar_url":"https://github.com/joelseq.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Surreal Search\n\nAn unofficial search engine for the SurrealDB documentation.\n\n![Screenshot](./assets/screenshot.png)\n\n## Development\n\n### 1. Spin up a Typesense cluster\nThis project uses Typesense as the search engine. You can use the `docker-compose.yml` file in the `typesense` directory to spin up a local Typesense cluster.\n```\ncd typesense \u0026\u0026 docker compose up -d\n```\n\n### 2. Create a `.env` file. You can copy the `.env.example` file for this which is pre-configured to work with the local Typesense cluster.\n\n### 3. Build the binary\n\nRun the following command to create a `sursearch` binary in the project root\n```\nmake build\n```\n\n### 4. Build the Typesense index\n\nRun `sursearch` with the `index` command to build the Typesense index. This will crawl through the entire SurrealDB documentation site.\n```\n./sursearch index\n```\n\nRun with --help to see full list of flags:\n```\n$ ./sursearch index --help\nThis command will (re-)build the index of the SurrealDB docs site in Typesense\n\nUsage:\n  sursearch index [flags]\n\nFlags:\n  -d, --depth uint8    Max depth to crawl for links (default 5)\n  -h, --help           help for index\n  -w, --workers uint   Number of workers to use (default 50)\n```\n\n### 5. Start the API server\n\nRun `sursearch` with the `serve` command which will spin up an API with a `/search` endpoint.\n```\n./sursearch serve\n```\n\nRun with --help to see full list of flags:\n```\n$ ./sursearch serve --help\nStart the Backend API\n\nUsage:\n  sursearch serve [flags]\n\nFlags:\n  -h, --help        help for serve\n  -p, --port uint   Port to run server on (default 8080)\n```\n\n### 6. Run the web app\n\nCreate a `.env.local` file from the `.env.example` file. The API url is configured to be the default port of the `serve` command above.\n\nFrom the `app` directory, run:\n```\npnpm dev\n```\nOR\n```\nnpm run dev\n```\n\nVisit the app at http://localhost:5173/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoelseq%2Fsurreal-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoelseq%2Fsurreal-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoelseq%2Fsurreal-search/lists"}