yunohost-admin/README.md

<h1 align="center">YunoHost Admin</h1>

<div align="center">
![Version](https://img.shields.io/github/v/tag/yunohost/yunohost-admin?label=version&sort=semver)
[![Tests status](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml/badge.svg)](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml)
[![Project license](https://img.shields.io/gitlab/license/yunohost/yunohost)](https://github.com/YunoHost/yunohost/blob/dev/LICENSE)

[YunoHost logo](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).

![Web admin insterface screenshot](./doc/home.png)
</div>

## Issues

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

## Translation

You can help translate Yunohost-Admin on our [translation platform](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)

<div align="center"><img alt="View of the translation rate for the different languages available in YunoHost" 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).  
Once you have a environment running and are attached to it (with `./ynh-dev start`) you will be able to run:

```bash
./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`.
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`<h1 align="center">YunoHost Admin</h1>`
Init 2013-07-01 15:56:32 +02:00
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`<div align="center">`
swag: Add version badge 2021-10-01 17:49:47 +02:00			`![Version](https://img.shields.io/github/v/tag/yunohost/yunohost-admin?label=version&sort=semver)`
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`[![Tests status](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml/badge.svg)](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml)`
swag: update README badges 2023-02-21 19:33:08 +01:00			`[![Project license](https://img.shields.io/gitlab/license/yunohost/yunohost)](https://github.com/YunoHost/yunohost/blob/dev/LICENSE)`
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`[YunoHost logo](https://yunohost.org) administration web interface (VueJS client for the API).`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01: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).`
Add screenshot in README 2021-11-12 17:48:30 +01:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`![Web admin insterface screenshot](./doc/home.png)`
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`</div>`

Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`## Issues`
[enh] readme: add translation badge status. 2017-01-28 06:22:20 +01:00
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`- [Please report issues on YunoHost bugtracker](https://github.com/YunoHost/issues).`
Update README.md 2015-10-25 14:15:56 +01:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`## Translation`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
Annnd typo 2021-10-01 17:39:17 +02:00			`You can help translate Yunohost-Admin on our [translation platform](https://translate.yunohost.org/engage/yunohost/?utm_source=widget)`
[enh] Improve README 2017-03-28 23:54:15 +02:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`<div align="center"><img alt="View of the translation rate for the different languages available in YunoHost" src="https://translate.yunohost.org/widgets/yunohost/-/admin/horizontal-auto.svg" alt="Translation status" /></div>`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			`## Developpers`
ready to merge fixing issue #21 2014-03-19 11:57:46 +01:00
swag: Update README with similar layout to yunohost and moulinette 2021-10-01 17:38:07 +02:00			`Contributions are welcome!`
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +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).`
update README 2021-01-19 19:23:22 +01:00			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
Readme: add pictures alt text and some markdown standardization 2024-03-09 06:21:23 +01:00			```bash
			`./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`.