{"id":21396632,"url":"https://github.com/badgerbloke/typesense-ui","last_synced_at":"2025-04-16T00:18:48.603Z","repository":{"id":244753786,"uuid":"816054074","full_name":"BadgerBloke/typesense-ui","owner":"BadgerBloke","description":"A dashboard for typesense built using NextJS","archived":false,"fork":false,"pushed_at":"2025-03-02T23:55:55.000Z","size":1334,"stargazers_count":2,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"trunk","last_synced_at":"2025-03-29T03:11:32.928Z","etag":null,"topics":["nextjs14","search-algorithm","search-engine","tailwindcss","typescript","typesense","typesense-dashboard","typesense-ui"],"latest_commit_sha":null,"homepage":"https://typesense.mksingh.dev","language":"TypeScript","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/BadgerBloke.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-06-16T23:45:44.000Z","updated_at":"2025-01-30T00:42:57.000Z","dependencies_parsed_at":"2024-11-27T06:16:08.972Z","dependency_job_id":null,"html_url":"https://github.com/BadgerBloke/typesense-ui","commit_stats":null,"previous_names":["badgerbloke/typesense-ui","ca-mksingh/typesense-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BadgerBloke%2Ftypesense-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BadgerBloke%2Ftypesense-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BadgerBloke%2Ftypesense-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BadgerBloke%2Ftypesense-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BadgerBloke","download_url":"https://codeload.github.com/BadgerBloke/typesense-ui/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249173408,"owners_count":21224531,"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":["nextjs14","search-algorithm","search-engine","tailwindcss","typescript","typesense","typesense-dashboard","typesense-ui"],"created_at":"2024-11-22T14:28:14.674Z","updated_at":"2025-04-16T00:18:48.585Z","avatar_url":"https://github.com/BadgerBloke.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typesense UI (Alpha) [Typesense v26.0 Compatible](https://typesense.org/docs/26.0/api/)\n\nAn OpenSource user interface for Typesense self-hosted instance.\n\n## All the available features are compatible with Typesense version 26.0\n\n# Welcome to the typesense-ui wiki!\n\n## Start Locally\n\n### Start Typesense Server\n\n#### Step 1: Clone the repo\n\n```bash\ngit clone https://github.com/BadgerBloke/typesense-ui.git\n```\n\n#### Step 2: Goto Scripts\n\n```bash\ncd typesense-ui/scripts\n```\n\n#### Step 3: Create `.env` file\n\n```bash\ncp .env-example .env\n```\n\nyou can change the values in `.env`\n\n#### Step 4: Start Typesense server\n\n```bash\ndocker compose up -d\n```\n\n#### Step 5: Check Typesense is up and running\n\n[http://localhost:8108/health](http://localhost:8108/health)\n_In case you have changed the value in `Step 3` then change the value here as well._\n\n---\n\n### Start Typesense-UI\n\n#### Goto `typesense-ui` root directory\n\n```bash\ncd ..\n```\n\n#### Step 2: Create `.env` file\n\n```bash\ncp .env-example .env\n```\n\n_In case you have changed the values in `Typesense Step 3` then update the same here as well._\n\n#### Step 3: Install NextJS dependencies\n\n```bash\npnpm i\n```\n\n_In case you are not using `pnpm` then delete `pnpm-lock.yaml` and run the dependencies installation command accordingly._\n\n#### Step 4: Start the App\n\n```bash\npnpm dev\n```\n\n_Run the command according to your package manager if not using `pnpm`_\n\n#### Step 5: Visit [http://localhost:3000](http://localhost:3000)\n\n---\n\n\u003cbr /\u003e\n\n-   [Official Typesense installation doc](https://typesense.org/docs/guide/install-typesense.html#docker-compose)\n\n\u003e ### Example pages\n\n-   Dashboard\n    \u003cimg src=\"./public/images/dashboard.png\" alt=\"create collection - page\" /\u003e\n-   Documents List\n    \u003cimg src=\"./public/images/documents.png\" alt=\"create collection - page\" /\u003e\n\n-   Index Document\n    \u003cimg src=\"./public/images/add-document.png\" alt=\"create collection - page\" /\u003e\n\n-   Create New Collection\n    \u003cimg src=\"./public/images/add-collection.png\" alt=\"create collection - page\" /\u003e\n\n-   Settings\n    \u003cimg src=\"./public/images/settings.png\" alt=\"settings - page\" /\u003e\n\n-   Crete API Key\n    \u003cimg src=\"./public/images/create-api-key.png\" alt=\"create api key - page\" /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadgerbloke%2Ftypesense-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadgerbloke%2Ftypesense-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadgerbloke%2Ftypesense-ui/lists"}