yunohost-admin/README.md

# YunoHost Admin

[YunoHost](https://yunohost.org) administration web interface (JS 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).

## Bug tracker

Please report issues on the [YunoHost bugtracker](https://github.com/YunoHost/issues).

## Translate

[![Translation status](https://translate.yunohost.org/widgets/yunohost/-/287x66-white.png)](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)

## Contributing

Feel free to improve the plugin and send a pull request.

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:

```
$ ./ynh-dev use-git yunohost-admin
```

This command will install all dependencies and start a dev server (based on [webpack-dev-server](https://github.com/webpack/webpack-dev-server)) with Hot-Module-Replacement (live updates on code modification without reloading the page nor rebuilding the whole code). After the build step, click on the "Network:" link and you are good to go.

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`.

## 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
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			`# YunoHost Admin`
Init 2013-07-01 15:56:32 +02:00
[enh] Improve README 2017-03-28 23:54:15 +02:00			`[YunoHost](https://yunohost.org) administration web interface (JS client for the API).`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
Language reworked 2019-10-16 02:21:37 +02:00			`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).`
[enh] readme: add translation badge status. 2017-01-28 06:22:20 +01:00
[enh] Improve README 2017-03-28 23:54:15 +02:00			`## Bug tracker`
Update README.md 2015-10-25 14:15:56 +01:00
Language reworked 2019-10-16 02:21:37 +02:00			`Please report issues on the [YunoHost bugtracker](https://github.com/YunoHost/issues).`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
[enh] Improve README 2017-03-28 23:54:15 +02:00			`## Translate`

			`[![Translation status](https://translate.yunohost.org/widgets/yunohost/-/287x66-white.png)](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			`## Contributing`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
Language reworked 2019-10-16 02:21:37 +02:00			`Feel free to improve the plugin and send a pull request.`
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00
update README 2021-01-19 19:23:22 +01:00			`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:
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00
update README 2021-01-19 19:23:22 +01:00			```
			`$ ./ynh-dev use-git yunohost-admin`
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			```

update README 2021-01-19 19:23:22 +01:00			`This command will install all dependencies and start a dev server (based on [webpack-dev-server](https://github.com/webpack/webpack-dev-server)) with Hot-Module-Replacement (live updates on code modification without reloading the page nor rebuilding the whole code). After the build step, click on the "Network:" link and you are good to go.`
simplify install and build 2016-05-14 23:22:41 +02:00
update README 2021-01-19 19:23:22 +01:00			`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.`
[enh] Remove old README and update current one. 2016-04-28 16:21:23 +02:00
update README 2021-01-19 19:23:22 +01:00			On a YunoHost instance, the web admin files are located at `/usr/share/yunohost/admin`.
[enh] Remove old README and update current one. 2016-04-28 16:21:23 +02:00
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			`## Dependencies`

update README 2021-01-19 19:23:22 +01:00			`* [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`