YunoHost/yunohost-admin
1
0
Fork 0
mirror of https://github.com/YunoHost/yunohost-admin.git synced 2024-09-03 20:06:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
axolotle 2021-01-19 19:23:22 +01:00
parent 778ea82d56
commit d8056a1a4b
2 changed files with 16 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -16,26 +16,27 @@ Please report issues on the [YunoHost bugtracker](https://github.com/YunoHost/is
Feel free to improve the plugin and send a pull request.
`gulp` is used to compile Less files and minify the JavaScript. Assuming [nodejs](http://nodejs.org/) is installed, you can install dependencies and run a build with:
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:
```sh
cd src
npm install
npm run build
```
$ ./ynh-dev use-git yunohost-admin
```
Alternatively you can run `npm run build-dev`, which improves building speed by bypassing compression tasks.
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`.
**Note:** The `.ms` - moustache - files are cached by the browser. You have to
reach them manually, and sometimes 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
* JS-cookie 2.1.0
* [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

21
app/README.md
View file

@ -1,21 +0,0 @@
## Setup
```bash
# clone this repo outside of the lxc (didn't try from inside for now)
# from yunohost-admin/app
# add a .env file with your lxc ip:
echo "VUE_APP_IP='Y.O.U.R.I.P'" > .env
# install dependencies
npm install
```
### Run in development
```bash
# from yunohost-admin/app
npm run serve
# go to https://localhost:8080/ and login
```