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 projet, and can not be installed directly. Please visit 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 us a pull request.

We use `gulp` to compile Less files and minify the JavaScript. Assuming [nodejs](http://nodejs.org/) is installed, you can install dependencies and run a build with:

```sh
cd src
npm install
npm run build
```

Alternatively you can run `npm run build-dev` which improves building speed by bypassing compression tasks.

On a YunoHost instance, the web admin files are located at `/usr/share/yunohost/admin`.

**Note:** The `.ms` - moustache - files are cached by the browser. You have to
reach them manually some times you modify them. (e.g. go to
https://example.com/yunohost/admin/views/domain/domain_list.ms)

## Dependencies

* Bootstrap 3.3.6
* Font-Awesome 4.5.0
* Handlebars 1.3.0
* Sammy 0.7.6
* Jquery-Cookie 2.1.0
[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
[enh] Improve README 2017-03-28 23:54:15 +02:00			`This client is a part of the YunoHost projet, and can not be installed directly. Please visit 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
[mod] we moved away from redmine 2018-06-07 13:40:25 +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
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			`Feel free to improve the plugin and send us a pull request.`

simplify install and build 2016-05-14 23:22:41 +02:00			We use `gulp` to compile Less files and minify the JavaScript. Assuming [nodejs](http://nodejs.org/) is installed, you can install dependencies and run a build with:
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00
			```sh
			`cd src`
[enh] Be more explicit on npm command. 2016-07-21 12:12:44 +02:00			`npm install`
simplify install and build 2016-05-14 23:22:41 +02:00			`npm run build`
[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			```

simplify install and build 2016-05-14 23:22:41 +02:00			Alternatively you can run `npm run build-dev` which improves building speed by bypassing compression tasks.

			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
			Note: The `.ms` - moustache - files are cached by the browser. You have to
			`reach them manually some times you modify them. (e.g. go to`
			`https://example.com/yunohost/admin/views/domain/domain_list.ms)`

[enh] Use Gulp to process Less, JS and images files. 2015-08-29 15:24:20 +02:00			`## Dependencies`

[doc] Update README with deps 2016-03-04 18:34:11 +01:00			`* Bootstrap 3.3.6`
			`* Font-Awesome 4.5.0`
			`* Handlebars 1.3.0`
			`* Sammy 0.7.6`
			`* Jquery-Cookie 2.1.0`