{"id":24553686,"url":"https://github.com/MKSinghDev/typesense-ui","last_synced_at":"2025-10-04T03:31:17.392Z","repository":{"id":244753786,"uuid":"816054074","full_name":"CA-MKSingh/typesense-ui","owner":"CA-MKSingh","description":"A dashboard for typesense built using NextJS","archived":false,"fork":false,"pushed_at":"2024-11-04T15:57:42.000Z","size":1514,"stargazers_count":1,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"trunk","last_synced_at":"2025-01-13T15:14:39.746Z","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/CA-MKSingh.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":"2024-09-02T03:49:06.000Z","dependencies_parsed_at":"2024-11-27T06:16:08.972Z","dependency_job_id":null,"html_url":"https://github.com/CA-MKSingh/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/CA-MKSingh%2Ftypesense-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CA-MKSingh%2Ftypesense-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CA-MKSingh%2Ftypesense-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CA-MKSingh%2Ftypesense-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CA-MKSingh","download_url":"https://codeload.github.com/CA-MKSingh/typesense-ui/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235213353,"owners_count":18953731,"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":"2025-01-23T02:11:51.684Z","updated_at":"2025-10-04T03:31:17.387Z","avatar_url":"https://github.com/CA-MKSingh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typesense UI (Beta) [Typesense v26.0 Compatible](https://typesense.org/docs/26.0/api/)\n\nAn OpenSource user interface for Typesense self-hosted instance.\n\n\u003e All the available features are compatible with Typesense version 26.0\n\nTable of Contents\n\n- 🧑🏻‍💻 [Development](#-development)\n- 🔐 [Authentication](#-authentication)\n- 🌐 [Production Deployment](#-production-deployment)\n\n## 🧑🏻‍💻 Development\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\nhere as well._\n\n#### Step 3: Install NextJS dependencies\n\n```bash\nbun i\n```\n\n_In case you are not using `bun` then delete `bun.lockb` and run the\ndependencies installation command accordingly._\n\n#### Step 4: Start the App\n\n```bash\nbun dev\n```\n\n_Run the command according to your package manager if not using `bun`_\n\n#### Step 5: Visit [http://localhost:3000](http://localhost:3000)\n\n---\n\n## 🔐 Authentication\n\nCurrently, there is two authentication providers supported.\n\n- Keycloak\n- Okta\n\nIf you want any other authentication provider to be supported, then you can raise a feature request [here](https://github.com/BadgerBloke/typesense-ui/issues/new?assignees=\u0026labels=enhancement\u0026template=feature_request.md\u0026title=)\n\nWhichever authentication providers' environment variables are set only those will appear on the login page.\n\nYou can check the `.env-example` file for the environment variables.\n\n![login](./public/images/login.png)\n\n---\n\n## 🌐 Production Deployment\n\nDownload the latest release code from [here](https://github.com/BadgerBloke/typesense-ui/releases/latest) and then extract the files.\n\nSet the proper environment variables either in `.env` or make it available in\nthe environment by exporting the variables. Now, you can build the docker image\nusing following command and then use the same.\n\n\u003e The point is that for self-hosting this NextJS app, you can use this Dockerfile to build the image.\n\n```bash\ndocker build -t typesense-ui .\n```\n\n---\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  ![dashboard](./public/images/dashboard.png)\n\n- Create New Collection\n  ![create collection](./public/images/add-collection.png)\n\n- Collections List\n  ![collections](./public/images/collections.png)\n\n- Documents List\n  ![documents](./public/images/documents.png)\n\n- Delete Documents\n  ![delete documents](./public/images/delete-documents.png)\n\n- Synonyms List\n  ![synonyms](./public/images/synonyms.png)\n\n- Curation List\n  ![curation](./public/images/curation.png)\n\n- Crete API Key\n  ![create api key](./public/images/add-api-key.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMKSinghDev%2Ftypesense-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMKSinghDev%2Ftypesense-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMKSinghDev%2Ftypesense-ui/lists"}