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: 5 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 (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T08:12:17.000Z (6 days ago)
- Last Synced: 2024-12-06T09:20:04.081Z (6 days 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: 6.97 MB
- Stars: 405
- Watchers: 4
- Forks: 52
- Open Issues: 2
-
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
ENGLISH ο½ [δΈζ](./README.zh-CN.md)
#### 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
> [!WARNING]
> 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)
## Configures
### Base Path
See this [issue](https://github.com/riccox/meilisearch-ui/issues/40).
You can configure the base path of this app by setting the `BASE_PATH` environment variable.
For example, if you want to deploy this app to the `/meilisearch-ui` path, you can set the `BASE_PATH` environment variable to `/meilisearch-ui`.
```sh
docker run -d --restart=always --name="meilisearch-ui" -p :24900 -e BASE_PATH="/meilisearch-ui" riccoxie/meilisearch-ui:latest
```
### 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 steps.
Clone this repo
```sh
git clone [email protected]:riccox/meilisearch-ui.git --depth=1
```
Go into root dir of repo
```sh
cd meilisearch-ui
```
install dependencies
```sh
pnpm install
```
create `.env.local` file at root dir of repo, input following config codes below
```
VITE_SINGLETON_MODE=true
VITE_SINGLETON_HOST=your-meilisearch-host
VITE_SINGLETON_API_KEY=your-api-key
```
> [!CAUTION]
> **Security Risk**
>
> See this [issue](https://github.com/riccox/meilisearch-ui/issues/161).
>
> `.env.local` file is local only and you should add it in your `.gitignore` to prevent them from being recorded by git.
>
> At the same time, any variables exposed in this way will eventually appear in the client package, so you should try to avoid using this method. When using singleton mode packaging, you need to carefully judge the network environment in which you deploy the application, and it is recommended to deploy in a trusted internal network environment.
- `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.
Next, build the singleton app.
```sh
pnpm build
```
Once the build is complete, you will find the `dist` directory in the root directory, which is a packaged SPA application directory that can be deployed to any server.
Then you will directly jump to the instance page when you open this app.
## Development
> [!NOTE]
> Install [pnpm](https://pnpm.io/installation) first.
```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