Add features
This commit is contained in:
parent
0c7a5b3bc7
commit
6b2da3d054
1 changed files with 17 additions and 6 deletions
23
README.md
23
README.md
|
|
@ -4,20 +4,31 @@
|
||||||
|
|
||||||
[Demo](https://kaermorchen.github.io/meiliadmin/) | [Screenshots](public/screenshots/)
|
[Demo](https://kaermorchen.github.io/meiliadmin/) | [Screenshots](public/screenshots/)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Search documents
|
||||||
|
- Indexes management
|
||||||
|
- Documents management
|
||||||
|
- Keys management
|
||||||
|
- Dumps management
|
||||||
|
- Document's views: table, json
|
||||||
|
- Validation for json settings
|
||||||
|
- Dark mode
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
You will need the following things properly installed on your computer.
|
You will need the following things properly installed on your computer.
|
||||||
|
|
||||||
* [Git](https://git-scm.com/)
|
* [Git](https://git-scm.com/)
|
||||||
* [Node.js](https://nodejs.org/) (with npm)
|
* [Volta](https://volta.sh/) or [Node.js](https://nodejs.org/) (with `yarn`)
|
||||||
* [Ember CLI](https://cli.emberjs.com/release/)
|
* [Ember CLI](https://cli.emberjs.com/release/)
|
||||||
* [Google Chrome](https://google.com/chrome/)
|
* `Firefox` or `Google Chrome` (`Firefox` is better 😛)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
* `git clone <repository-url>` this repository
|
* `git clone <repository-url>` this repository
|
||||||
* `cd meiliadmin`
|
* `cd meiliadmin`
|
||||||
* `npm install`
|
* `yarn install`
|
||||||
|
|
||||||
## Running / Development
|
## Running / Development
|
||||||
|
|
||||||
|
|
@ -36,8 +47,8 @@ Make use of the many generators for code, try `ember help generate` for more det
|
||||||
|
|
||||||
### Linting
|
### Linting
|
||||||
|
|
||||||
* `npm run lint`
|
* `yarn lint`
|
||||||
* `npm run lint:fix`
|
* `yarn lint:fix`
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
|
|
@ -52,7 +63,7 @@ Make use of the many generators for code, try `ember help generate` for more det
|
||||||
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
|
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
|
||||||
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
|
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
|
||||||
|
|
||||||
## Install Meilisearch
|
## Install dummy Meilisearch instance
|
||||||
```bash
|
```bash
|
||||||
# Create folder
|
# Create folder
|
||||||
$ mkdir data && cd data
|
$ mkdir data && cd data
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue