Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riccox/meilisearch-ui
😎 An open-source, pretty, simple and fast ⚡ meilisearch admin dashboard UI for managing your meilisearch instances 🕹
https://github.com/riccox/meilisearch-ui
admin admin-dashboard admin-panel console dashboard hacktoberfest meilisearch meilisearch-dashboard react reactjs search search-engine searchview typescript ui vercel vitejs
Last synced: 28 days ago
JSON representation
😎 An open-source, pretty, simple and fast ⚡ meilisearch admin dashboard UI for managing your meilisearch instances 🕹
- Host: GitHub
- URL: https://github.com/riccox/meilisearch-ui
- Owner: riccox
- License: apache-2.0
- Created: 2022-08-28T13:28:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T07:05:49.000Z (4 months ago)
- Last Synced: 2024-09-28T23:02:40.753Z (about 1 month ago)
- Topics: admin, admin-dashboard, admin-panel, console, dashboard, hacktoberfest, meilisearch, meilisearch-dashboard, react, reactjs, search, search-engine, searchview, typescript, ui, vercel, vitejs
- Language: TypeScript
- Homepage: https://meilisearch-ui.riccox.com
- Size: 1.08 MB
- Stars: 355
- Watchers: 4
- Forks: 44
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-meilisearch - Meilisearch-UI - A UI to manage instances (Tools / Community Tools)
README
# Meilisearch-UI
#### An open-source, pretty, simple and fast meilisearch admin dashboard UI for managing your meilisearch instances
> [IMPORTANT] The main branch may be unstable or unavailable during development.
>
> Please use release instead of main branch to obtain a stable version app
## Features
🚀 Indexes CRUD
🔎 Search documents
💪 Documents management
🛠️️ Index settings
⚓ Multiple instances management
🔒 Data is stored inside your browser
📦 Docker image support
🎱 Singleton mode support (easy to integrate with your own apps)
🌐 I18n support (en, zh)
## Quick start
> ⚠️ This app have not achieved responsive design totally, so mind that only use this app on desktop to gain better experience.
### CORS settings
✅ Remember update CORS settings in your instance server for this ui domain before using.
Because this app use meilisearch official JS client to call your meilisearch instance, you need to manually configure CORS settings in your web server to make sure ui panel can access your instance server with api calls.
Add your ui panel deployment domain to your instance server cors list.
ex:
```conf
# ... other configurations
add_header Access-Control-Allow-Origin "your.meilisearch-ui.domain.com";
# ... other configurations
```
[Learn how to configure CORS settings in your web server](https://enable-cors.org/)
### Online use
There is a live demo 👉 [meilisearch-ui](https://meilisearch-ui.riccox.com), deploy on Vercel.
### Docker
```sh
docker pull riccoxie/meilisearch-ui:latest
docker run -d --restart=always --name="meilisearch-ui" -p :24900 riccoxie/meilisearch-ui:latest
```
### Deploy on Vercel
You can deploy this app to the cloud
with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme)
Just one click the button below to deploy this app automatically
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Friccox%2Fmeilisearch-ui&project-name=meilisearch-ui)
### Singleton mode
See this [issue](https://github.com/riccox/meilisearch-ui/issues/43).
If you want to use this app with only one meilisearch instance, you can enable the singleton mode by below config.
Then you will directly jump to the instance page when you open this app.
Just need to start this app with some env variables like below.
```sh
VITE_SINGLETON_MODE=true
VITE_SINGLETON_HOST=http://localhost:27700
VITE_SINGLETON_API_KEY=your-api-key
```
- `VITE_SINGLETON_MODE` tell this app to enable singleton mode.
- `VITE_SINGLETON_HOST` is the meilisearch host url.
- `VITE_SINGLETON_API_KEY` is the meilisearch master key.
## Development
```sh
git clone [email protected]:riccox/meilisearch-ui.git
cd meilisearch-ui
pnpm install
pnpm dev
```
## Built with ♥
- Meilisearch
- Tanstack
- React v18
- Arco design
- Semi UI
- Mantine UI
- Next UI
- Radix UI
- Tabler Icon
- Lucide Icon
- Monaco Editor for react
- TypeScript
- Vite
- Zustand
- TailwindCSS
- React Error Boundary
- Prettier
- Fuse.js
- Echarts
- Lodash.js
- Immer
- Ahooks
- Framer motion
- react-json-view
- Dayjs
- I18Next
- UnoCSS
- qs
- Sonner
- Vaul
- Zod