Merge pull request #52 from kaermorchen/install-doc

Added "How to use it"
This commit is contained in:
Stanislav Romanov 2023-05-20 07:25:07 +03:00 committed by GitHub
commit ca867e871d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 2 deletions

View file

@ -35,8 +35,9 @@ Make use of the many generators for code, try `ember help generate` for more det
### Building
* `ember build` (development)
* `ember build --environment production` (production)
* `npm start` (development and watch)
* `npm run build` (production)
* `ROOTURL=/admin/ npm run build` (production build with rooturl, example: https://example.com/admin/)
## Further Reading / Useful Links

View file

@ -15,6 +15,12 @@
- ✅ Validation for json settings
- 🌙 Dark mode
## How to use it
Meiliadmin is an [Ember](https://emberjs.com/) application. There are some way for use it:
1. Just use the [demo](https://kaermorchen.github.io/meiliadmin/) page with your meilisearch instance.
1. Install it in you domain, extract the asset `dist.tgz` from the [latest realese](https://github.com/kaermorchen/meiliadmin/releases/latest).
1. For custom building the app, see the [development page](DEVELOPMENT.md#building).
## Screenshots
![start](https://github.com/kaermorchen/meiliadmin/assets/11972062/29507812-d9d9-4cc0-8f9c-400c98fdd064)