mirror of
https://github.com/YunoHost/yunohost-admin.git
synced 2024-09-03 20:06:15 +02:00
swag: Update README with similar layout to yunohost and moulinette
This commit is contained in:
parent
5efb5b33e7
commit
249352ff67
1 changed files with 20 additions and 20 deletions
40
README.md
40
README.md
|
@ -1,20 +1,32 @@
|
||||||
# YunoHost Admin
|
<h1 align="center">YunoHost Admin</h1>
|
||||||
|
|
||||||
[YunoHost](https://yunohost.org) administration web interface (JS client for the API).
|
<div align="center">
|
||||||
|
|
||||||
|
[![Tests status](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml/badge.svg)](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml)
|
||||||
|
[![GitHub license](https://img.shields.io/github/license/YunoHost/yunohost-admin)](https://github.com/YunoHost/yunohost-admin/blob/dev/LICENSE)
|
||||||
|
|
||||||
|
[YunoHost](https://yunohost.org) administration web interface (VueJS client for the API).
|
||||||
|
|
||||||
This client is a part of the YunoHost project, and can not be installed directly. Please visit the YunoHost website for [installation instructions](https://yunohost.org/install).
|
This client is a part of the YunoHost project, and can not be installed directly. Please visit the YunoHost website for [installation instructions](https://yunohost.org/install).
|
||||||
|
|
||||||
## Bug tracker
|
</div>
|
||||||
|
|
||||||
Please report issues on the [YunoHost bugtracker](https://github.com/YunoHost/issues).
|
Issues
|
||||||
|
------
|
||||||
|
|
||||||
## Translate
|
- [Please report issues on YunoHost bugtracker](https://github.com/YunoHost/issues).
|
||||||
|
|
||||||
[![Translation status](https://translate.yunohost.org/widgets/yunohost/-/287x66-white.png)](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)
|
Translation
|
||||||
|
-----------
|
||||||
|
|
||||||
## Contributing
|
You can help translate Moulinette on our [translation platform](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)
|
||||||
|
|
||||||
Feel free to improve the plugin and send a pull request.
|
<div align="center"><img src="https://translate.yunohost.org/widgets/yunohost/-/admin/horizontal-auto.svg" alt="Translation status" /></div>
|
||||||
|
|
||||||
|
Developpers
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Contributions are welcome!
|
||||||
|
|
||||||
In order to contribute you will need to setup a development environment using [ynh-dev](https://github.com/YunoHost/ynh-dev) (see the README).
|
In order to contribute you will need to setup a development environment using [ynh-dev](https://github.com/YunoHost/ynh-dev) (see the README).
|
||||||
Once you have a environment running and are attached to it (with `./ynh-dev start`) you will be able to run:
|
Once you have a environment running and are attached to it (with `./ynh-dev start`) you will be able to run:
|
||||||
|
@ -28,15 +40,3 @@ This command will install all dependencies and start a dev server (based on [web
|
||||||
You can also install [Vue Devtools](https://addons.mozilla.org/fr/firefox/addon/vue-js-devtools/) (module for Firefox but also exists for Chromium/Chrome) if you want component trees, performance views and so on.
|
You can also install [Vue Devtools](https://addons.mozilla.org/fr/firefox/addon/vue-js-devtools/) (module for Firefox but also exists for Chromium/Chrome) if you want component trees, performance views and so on.
|
||||||
|
|
||||||
On a YunoHost instance, the web admin files are located at `/usr/share/yunohost/admin`.
|
On a YunoHost instance, the web admin files are located at `/usr/share/yunohost/admin`.
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
* [Vue.js](https://vuejs.org/v2/guide/)
|
|
||||||
* [BootstrapVue](https://bootstrap-vue.org/docs)
|
|
||||||
* [Vue i18n](https://kazupon.github.io/vue-i18n/started.html)
|
|
||||||
* [Vue Router](https://router.vuejs.org/guide/)
|
|
||||||
* [Vuex](https://vuex.vuejs.org/)
|
|
||||||
* [Vuelidate](https://vuelidate.js.org/#getting-started)
|
|
||||||
* [date-fns](https://date-fns.org/v2.16.1/docs/Getting-Started)
|
|
||||||
* [Fork Awesome](https://forkaweso.me/Fork-Awesome/icons/) for icons
|
|
||||||
* [FiraGO](https://bboxtype.com/typefaces/FiraGO/#!layout=specimen) and [Fira Code](https://github.com/tonsky/FiraCode) for fonts
|
|
||||||
|
|
Loading…
Reference in a new issue