yunohost-admin/README.md

42 lines
1.4 KiB
Markdown
Raw Normal View History

# YunoHost Admin
2013-07-01 15:56:32 +02:00
2017-03-28 23:54:15 +02:00
[YunoHost](https://yunohost.org) administration web interface (JS client for the API).
2014-03-19 11:57:46 +01:00
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).
2017-03-28 23:54:15 +02:00
## Bug tracker
2015-10-25 14:15:56 +01:00
2017-03-28 23:54:15 +02:00
Please report issues on the [YunoHost Bugtracker](https://dev.yunohost.org/projects/yunohost/issues), no registration needed.
2014-03-19 11:57:46 +01:00
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)
2014-03-19 11:57:46 +01:00
## Contributing
2014-03-19 11:57:46 +01:00
Feel free to improve the plugin and send us a pull request.
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:
```sh
cd src
2016-07-21 12:12:44 +02:00
npm install
2016-05-14 23:22:41 +02:00
npm run 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`.
**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
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