[enh] Add explanation about ynh-dev

This commit is contained in:
Zamentur aka ljf 2015-10-12 02:44:20 +02:00
parent 4dc4d05839
commit 1161d65d25

View file

@ -41,11 +41,84 @@ Le service yunohost-api doit donc être start pour utiliser l'administration web
### Installation de lenvironnement de développement
<div class="alert alert-warning">
<b>Attention :</b> partie est en cours de rédaction.
<b>Attention :</b> Cette partie est en cours de rédaction. La ligne de commande `ynh-dev` vient juste d'être créée il est possible qu'il y ai des manques.
</div>
Afin de vous simplifier la tâche un dépôt dédié a été créé afin de créer un environnement de développement.
Une ligne de commande `ynh-dev` a été créé afin de simplifier la gestion de votre environnement de developpement.
```bash
git clone --recursive https://github.com/zamentur/yunohost-development
```
wget https://raw.githubusercontent.com/zamentur/yunohost-development/master/ynh-dev
chmod u+x ynh-dev
```
Pour créer votre environnement, commencez par faire un `create-env`
```bash
./ynh-dev create-env ~/project/my/yunohost/env
```
Cette sous commande va cloner les dépots principaux et les positionner en `unstable`. Si vous avez vos propres fork, vous pouvez ensuite faire ce qu'il faut pour changer l'origine et le remote repository.
#### Usage
##### Lancer un container
Positionner vous dans votre environnement, puis créer et entrer dans une vm à l'aide de `ynh-dev run`
```bash
cd ~/project/my/yunohost/env
./ynh-dev run exemple.local docker stable8
root@yunohost:/# cd yunohost
root@yunohost:/yunohost/# ls
Dockerfile LICENSE README.md SSOwat apps backup moulinette ynh-dev yunohost yunohost-admin yunohost-vagrant
```
##### Mettre à jour un container
Si la vm n'est pas à jour lancez un `ynh-dev upgrade`:
```bash
root@yunohost:/yunohost/# ./ynh-dev upgrade
```
##### Déployer les sources présentes dans votre environnement
Pour déployer les sources se trouvant dans votre environement de developpement faites:
```bash
root@yunohost:/yunohost/# ./ynh-dev deploy
```
<div class="alert alert-warning">
<b>Attention :</b> pour yunohost-admin vous devez avoir compiler le js avec gulp au préalable
</div>
<div class="alert alert-info">
<b>Note :</b> vous pouvez sélectionner les paquets à déployer exemple: `./ynh-dev deploy yunohost yunohost-admin`
</div>
##### Lancer la postinstall
Avec Docker
```bash
root@yunohost:/yunohost/# postinstall
```
Avec VirtualBox/Vagrant
```bash
root@yunohost:/yunohost/# yunohost tools postinstall
```
##### Récupérer l'ip de la vm et parametrer son /etc/hosts
Si vous ne connaissez pas l'ip de votre vm:
```bash
root@yunohost:/yunohost/# ./ynh-dev ip
172.17.0.1
```
Pour tester dans votre navigateur vous pouvez modifier votre fichier /etc/hosts afin de faire pointer votre domaine sur la bonne ip. Par exemple en y ajoutant une ligne semblable à celle ci
```
172.17.0.1 exemple.local
```
##### Déployer les sources au fur et à mesure des modifications
```bash
root@yunohost:/yunohost/# ./ynh-dev watch
```
<div class="alert alert-info">
<b>Astuce :</b> dans le cas de modification sur yunohost-admin, cette commande est trés pratique couplée avec un `gulp watch` sur la machine hôte.
</div>