Skip to content

Commit b2392a6

Browse files
committed
Add something to the readme
1 parent 51f0f48 commit b2392a6

1 file changed

Lines changed: 42 additions & 2 deletions

File tree

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# meili-ui
2-
A super lightweight UI for Meilisearch
1+
# Meili UI
2+
3+
A super lightweight User Iinterface for Meilisearch.
4+
5+
## Goals
6+
7+
The plan is to build out a UI to not only perform searches, but also manage Meilisearch instances.
8+
9+
- [x] List & Search indexes
10+
- [ ] Connect to multiple instances
11+
- [ ] Manage Keys & permissions
12+
- [ ] Manage Index settings
13+
- [ ] Monitor tasks
14+
- [ ] Create snapshots
15+
16+
Contributions are most welcome.
17+
18+
## Install
19+
20+
There is nothing fancy here, no build steps, just simple HTML, CSS and Javascript.
21+
22+
Clone the repo onto your server:
23+
24+
```bash
25+
git clone git@github.com:tobz-nz/meili-ui.git /path-to-public-folder
26+
```
27+
28+
Then open it in your browser:
29+
30+
```bash
31+
open https://your-site.example/meili-ui
32+
```
33+
34+
## Why
35+
36+
I started this project for 2 reasons:
37+
38+
1. The UI that runs on Meilisearch is VERY basic.
39+
2. I've been wanting to experiment with native Web Components for a few years, and now seems to be the time.
40+
41+
Yeah, yeah - I'm using the small [Web Component Base](https://github.com/ayoayco/web-component-base) library so I don't have to muck about with WC boilerplates. So what?
42+
I have done that stuff and TBH, I can't be bothered. Web Component Base is really quite nice, so stuff you guys :laughing:

0 commit comments

Comments
 (0)