Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meilisearch/mini-dashboard
mini-dashboard for Meilisearch
https://github.com/meilisearch/mini-dashboard
meilisearch react
Last synced: 5 days ago
JSON representation
mini-dashboard for Meilisearch
- Host: GitHub
- URL: https://github.com/meilisearch/mini-dashboard
- Owner: meilisearch
- License: mit
- Created: 2021-03-08T10:38:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T06:36:10.000Z (3 months ago)
- Last Synced: 2024-08-02T15:51:21.875Z (3 months ago)
- Topics: meilisearch, react
- Language: JavaScript
- Homepage: https://edge-preview-meili.vercel.app
- Size: 7.41 MB
- Stars: 222
- Watchers: 7
- Forks: 50
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Mini Dashboard
---
🚨 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](https://meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=minidashboard). For instance, it offers a convenient solution for managing your index settings.*
*Seeking immediate support? Please join us on [our Discord server](https://discord.meilisearch.com).*
---
Website |
Meilisearch Cloud |
Blog |
Documentation |
Discord
> Meilisearch is an open-source search engine that offers fast, relevant search out of the box.
👉 [Meilisearch repository](https://github.com/meilisearch/meilisearch)
Meilisearch's mini-dashboard. A web-app served by the engine with a minimal search experience on your data.
**Table of Contents**:
- [Setup](#setup)
- [Run](#run)
- [Build](#build)
- [Generate build](#generate-build)
- [Specify Meilisearch's server URL](#specify-meilisearchs-server-url)
- [Run your build](#run-your-build)
- [Storybook](#storybook)
- [Contributing](#contributing)
## Setup
```bash
yarn
```
## Run
```bash
yarn start
```
Go to `http://localhost:3000/` and enjoy ! 🎉
## Build
### Generate build
You can generate a build of this project with the following command:
```bash
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:
```bash
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:
```bash
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.
```bash
yarn storybook
```
## Docker
You can also run the mini-dashboard with Docker.
```bash
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](./CONTRIBUTING.md)
## Compatibility with Meilisearch
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/mini-dashboard/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.