https://github.com/badgerbloke/typesense-ui
A dashboard for typesense built using NextJS
https://github.com/badgerbloke/typesense-ui
nextjs14 search-algorithm search-engine tailwindcss typescript typesense typesense-dashboard typesense-ui
Last synced: about 1 year ago
JSON representation
A dashboard for typesense built using NextJS
- Host: GitHub
- URL: https://github.com/badgerbloke/typesense-ui
- Owner: BadgerBloke
- License: mit
- Created: 2024-06-16T23:45:44.000Z (about 2 years ago)
- Default Branch: trunk
- Last Pushed: 2025-03-02T23:55:55.000Z (over 1 year ago)
- Last Synced: 2025-03-29T03:11:32.928Z (over 1 year ago)
- Topics: nextjs14, search-algorithm, search-engine, tailwindcss, typescript, typesense, typesense-dashboard, typesense-ui
- Language: TypeScript
- Homepage: https://typesense.mksingh.dev
- Size: 1.27 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typesense UI (Alpha) [Typesense v26.0 Compatible](https://typesense.org/docs/26.0/api/)
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
```bash
git clone https://github.com/BadgerBloke/typesense-ui.git
```
#### Step 2: Goto Scripts
```bash
cd typesense-ui/scripts
```
#### Step 3: Create `.env` file
```bash
cp .env-example .env
```
you can change the values in `.env`
#### Step 4: Start Typesense server
```bash
docker compose up -d
```
#### Step 5: Check Typesense is up and running
[http://localhost:8108/health](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
```bash
cd ..
```
#### Step 2: Create `.env` file
```bash
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
```bash
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
```bash
pnpm dev
```
_Run the command according to your package manager if not using `pnpm`_
#### Step 5: Visit [http://localhost:3000](http://localhost:3000)
---
- [Official Typesense installation doc](https://typesense.org/docs/guide/install-typesense.html#docker-compose)
> ### Example pages
- Dashboard
- Documents List
- Index Document
- Create New Collection
- Settings
- Crete API Key
