mirror of
https://github.com/YunoHost/yunohost-admin.git
synced 2024-09-03 20:06:15 +02:00
[enh] Add a README with an how-to hack the interface
This commit is contained in:
parent
01b5246f83
commit
6b839ccd65
1 changed files with 26 additions and 0 deletions
26
src/README.md
Normal file
26
src/README.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# YunoHost Web Admin
|
||||||
|
|
||||||
|
This is a JavaScript client to the YunoHost [moulinette API](https://github.com/YunoHost/yunohost).
|
||||||
|
|
||||||
|
|
||||||
|
### Hack
|
||||||
|
|
||||||
|
On a YunoHost instance, the web admin files are located on `/usr/share/yunohost/admin`. In order to fetch the latest development version and hack it, you will roughly have to:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Fetch sources
|
||||||
|
cd /usr/share/yunohost/
|
||||||
|
mv admin admin.back
|
||||||
|
git clone https://github.com/YunoHost/yunohost-admin
|
||||||
|
ln -s /usr/share/yunohost/yunohost-admin/src admin
|
||||||
|
|
||||||
|
# Install Gulp
|
||||||
|
apt-get install nodejs nodejs-legacy npm -y
|
||||||
|
cd admin
|
||||||
|
npm install
|
||||||
|
node_modules/.bin/gulp build
|
||||||
|
```
|
||||||
|
|
||||||
|
You are now ready to modify the interface. Do not hesitate to run `node_modules/.bin/gulp watch` when you modify `.js` and `.css` files, since they need to be rebuilt.
|
||||||
|
|
||||||
|
**Note:** The `.ms` - moustache - files are cached by the browser. You have to reach them manually every time you change them. (e.g. go to https://example.com/yunohost/admin/views/domain/domain_list.ms)
|
Loading…
Reference in a new issue