Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beeequeue/mini-meili
🤏 a tiny MeiliSearch web client
https://github.com/beeequeue/mini-meili
meilisearch melt-ui svelte svelte5
Last synced: 5 days ago
JSON representation
🤏 a tiny MeiliSearch web client
- Host: GitHub
- URL: https://github.com/beeequeue/mini-meili
- Owner: beeequeue
- Created: 2024-12-14T14:27:39.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2024-12-27T14:01:30.000Z (12 days ago)
- Last Synced: 2024-12-27T15:17:58.548Z (12 days ago)
- Topics: meilisearch, melt-ui, svelte, svelte5
- Language: Svelte
- Homepage: http://mini-meili.haglund.dev/
- Size: 466 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mini-meili, a tiny MeiliSearch web client
An alternative to the official, unmaintained [Mini Dashboard](https://github.com/meilisearch/mini-dashboard) and [meilisearch-ui](https://github.com/riccox/meilisearch-ui).
- More features
- Actually usable on small screens
- Usable via keyboard only (visual feedback should be improved)
- _(todo) Exclude fields in index_
- More portable
- Can connect to any MeiliSearch instance
- Easy to self-host if need be
- Configure via URL parameters
- More smaller
- 193kb vs. 752kb vs. 1.5mb
- Built with Svelte 5
## Configuration
**DO NOT USE AN API KEY THAT HAS WRITE PERMISSIONS!**
The client can't use any write permissions, so using a key with more permissions than needed is just insecure with no benefits.
The client requires the API key to have these permissions:
- `search`
- `indexes.get`
- `stats.get`
- `version`
### URL Parameters
You can pre-configure the client by passing URL parameters.
- `host`: The URL of the MeiliSearch instance to connect to
- `api_key`: The API key to use
Example:
```url
https://mini-meili.haglund.dev/?host=https://search.haglund.dev&api_key=22b483672526a6eb07f464cf3bdae5924ff25d031b7d69968eb5babccbbd9c79
```
## Self-hosting
### Docker
A docker image is available that uses nginx to serve the static files for you.
```command
docker run -d -p {YOUR PORT}:80 --name mini-meili ghcr.io/beeequeue/mini-meili:latest
```
```yaml
# compose.yml
services:
mini-meili:
image: ghcr.io/beeequeue/mini-meili:latest
container_name: mini-meili
restart: always
ports:
- {YOUR PORT}:80
```
## Development
1. Set up node and pnpm
1. Install dependencies: `pnpm install`
1. Run dev server: `pnpm dev`
1. Open `localhost:5173` in your browser