https://github.com/zperf/meili-dashboard
https://github.com/zperf/meili-dashboard
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zperf/meili-dashboard
- Owner: zperf
- License: mit
- Created: 2023-08-30T16:44:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T03:50:24.000Z (about 2 years ago)
- Last Synced: 2024-05-10T04:38:02.800Z (about 2 years ago)
- Language: JavaScript
- Size: 5.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Mini Dashboard
Meilisearch |
Documentation |
Discord |
Website |
FAQ
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
```
## 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.