Typesense admin dashboard

Welcome to the Typesense Admin Dashboard GitHub repository! This open-source project provides a user-friendly interface to manage your Typesense search engine effortlessly. It is built using Next.js, Tailwind CSS, redux-toolkit, Shadcn and Typesense.

It is still in active development and we are working on polishing,finetuning and adding more features. If you have any feedback or suggestions, please feel free to open an issue

Project goals

The project aims to provide a user friendly interface to manage your typesense server.

Features

• Intuitive Search Management: Easily configure collections, define schema fields, and fine-tune search settings with a clean and intuitive interface.
• Real-time Monitoring: Gain valuable insights into your search engine's performance, query analytics, and indexing status, enabling you to optimize and improve search results.
• Advanced Settings: Fine-tune advanced search features to customize the search experience.

Getting Started

Quick setup Using Docker compose

The project contains two docker compose files at the root of the appliation:

• docker-compose.yml

  version: "3"
  services:
    typesense:
      image: typesense/typesense:0.25.0.rc36
      entrypoint: sh -c "/opt/typesense-server --data-dir /data --api-key=abc --enable-cors"
      ports:
        - "8108:8108"
      volumes:
        - typesense-data:/data
    admin_dashboard:
      container_name: admin_dashboard
      image: ghcr.io/lewynation/typesense-admin-dashboard:latest
      restart: always
      ports:
        - 3005:3000
  volumes:
    typesense-data:
      driver: local

  Runs the dashboard alongside the typesense server. Exposes the dashboard on port 3000 and typesense on port 8108. Perfect for development or just trying out the dashboard. Provide a suitable typesense server API Key by modifying the --api-key flag in the entrypoint of the typesense service. Ensure that cors is enabled on the typesense server with the --enable-cors flag. Typesense does not have a latest tag on the Docker Hub. You can find a list of all available tags here. The dashboard as well doesn't have a latest tag. Check the latest version here.

• docker-compose-solo.yml

  version: "3"
  services:
    admin_dashboard:
      container_name: admin_dashboard
      image: ghcr.io/lewynation/typesense-admin-dashboard:latest
      restart: always
      ports:
        - 3005:3000

  Only runs the admin dashboard. A running instance of typesense with --enable-cors set to true is required. Exposes the dashboard on port 3005. Check the latest version of the dashboard here.

Useful Links

• Typesense
• Existing dashboard