README.md

Typesense UI (Alpha) Typesense v26.0 Compatible

An OpenSource user interface for Typesense self-hosted instance.

All the available features are compatible with Typesense version 26.0

Welcome to the typesense-ui wiki!

Start Locally

Start Typesense Server

Step 1: Clone the repo

git clone https://github.com/BadgerBloke/typesense-ui.git

Step 2: Goto Scripts

cd typesense-ui/scripts

Step 3: Create .env file

cp .env-example .env

you can change the values in .env

Step 4: Start Typesense server

docker compose up -d

Step 5: Check Typesense is up and running

http://localhost:8108/health In case you have changed the value in Step 3 then change the value here as well.

---

Start Typesense-UI

Goto typesense-ui root directory

cd ..

Step 2: Create .env file

cp .env-example .env

In case you have changed the values in Typesense Step 3 then update the same here as well.

Step 3: Install NextJS dependencies

pnpm i

In case you are not using pnpm then delete pnpm-lock.yaml and run the dependencies installation command accordingly.

Step 4: Start the App

pnpm dev

Run the command according to your package manager if not using pnpm

Step 5: Visit http://localhost:3000

---

• Official Typesense installation doc

Example pages

• Dashboard

• Documents List

• Index Document

• Create New Collection

• Settings

• Crete API Key