Home

Awesome

<p align="center"> <img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/logo.svg" alt="Meilisearch logo" width="200" height="200" /> </p> <h1 align="center">Mini Dashboard</h1>

🚨 IMPORTANT NOTICE: Reduced Maintenance & Support 🚨

Dear Community,

We'd like to share some updates regarding the future maintenance of this repository:

Our team is small, and our availability will be reduced in the upcoming times. As such, response times might be slower, and we will not be accepting enhancements for this repository moving forward.

If you're looking for reliable alternatives, consider using Meilisearch Cloud. For instance, it offers a convenient solution for managing your index settings.

Seeking immediate support? Please join us on our Discord server.

<h4 align="center"> <a href="https://www.meilisearch.com/?utm_campaign=oss&utm_source=github&utm_medium=minidashboard">Website</a> | <a href="https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=minidashboard">Meilisearch Cloud</a> | <a href="https://blog.meilisearch.com/?utm_campaign=oss&utm_source=github&utm_medium=minidashboard">Blog</a> | <a href="https://meilisearch.com/docs?utm_campaign=oss&utm_source=github&utm_medium=minidashboard">Documentation</a> | <a href="https://discord.meilisearch.com/?utm_campaign=oss&utm_source=github&utm_medium=minidashboard">Discord</a> </h4>

Meilisearch is an open-source search engine that offers fast, relevant search out of the box.

👉 Meilisearch repository

<p align="center" style="font-weight:bold;">Meilisearch's mini-dashboard. A web-app served by the engine with a minimal search experience on your data.</p> <br/> <p align="center"> <img src="assets/trumen_quick_loop.gif" alt="Web interface gif" /> </p> <br/>

Table of Contents:

<br/>

Setup

yarn

Run

yarn start

Go to http://localhost:3000/ and enjoy ! 🎉

Build

Generate build

You can generate a build of this project with the following command:

yarn build

Specify Meilisearch's server URL

⚠️ By default, the application will call Meilisearch at the exact same address as it is running. Example: if your app is running at http://localhost:5000, it will try to call http://localhost:5000/indexes to retrieve the list of your indexes.

If you want to specify the URL where your Meilisearch is running, use the REACT_APP_MEILI_SERVER_ADDRESS environment variable.

Example:

REACT_APP_MEILI_SERVER_ADDRESS=http://0.0.0.0:7700 yarn build

Run your build

The above commands will generate an optimized version of the app, inside the build folder.

You can then serve it with any web server of your choice.

Example:

serve build

Storybook

Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively test components.

Storybook

yarn storybook

Docker

You can also run the mini-dashboard with Docker.

docker build -t meilisearch-mini-dashboard .
docker run -it -e REACT_APP_MEILI_SERVER_ADDRESS=http://localhost:7700 -p 3000:3000 meilisearch-mini-dashboard

Contributing

If you want to contribute to this project, please make sure to read the contributing guidelines

Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.