mirror of
https://github.com/YunoHost/ynh-dev.git
synced 2024-09-03 20:05:59 +02:00
68 lines
1.3 KiB
Markdown
68 lines
1.3 KiB
Markdown
# ynh-dev, a yunohost dev env
|
||
|
||
This script is a cli to manage a yunohost development environement.
|
||
With this you can develop on the unstable version of yunohost quickly.
|
||
|
||
## Setup
|
||
|
||
Install dependencies
|
||
```shell
|
||
# Debian, Ubuntu, Mint
|
||
sudo apt-get install vagrant
|
||
# Fedora
|
||
sudo dnf install vagrant vagrant-libvirt
|
||
```
|
||
|
||
Next download ynh-dev script
|
||
|
||
```shell
|
||
wget https://github.com/YunoHost/ynh-dev/raw/opi-boxes/ynh-dev
|
||
chmod u+x ynh-dev
|
||
```
|
||
|
||
## Host usage
|
||
|
||
The `ynh-dev` tool provides 2 usefull command to run into your host machine. One
|
||
create a development environment by cloning Git repositories, the other one is a
|
||
helper to run a Vagrant virtual machine in the right place.
|
||
|
||
### Create the environment
|
||
|
||
```shell
|
||
ynh-dev create-env /path/to/dev/env
|
||
```
|
||
|
||
### Run a container
|
||
```
|
||
cd /path/to/dev/env
|
||
ynh-dev run ynh.local testing
|
||
```
|
||
|
||
## Inside the Virtual machine (VM)
|
||
|
||
Once logged into your VM, go to `/vagrant` to enjoy folder sharing, and take
|
||
advantages of the `ynh-dev` script.
|
||
|
||
### Upgrade the container
|
||
```
|
||
/vagrant/ynh-dev upgrade
|
||
```
|
||
|
||
### Deploy your change
|
||
```
|
||
/vagrant/ynh-dev deploy
|
||
```
|
||
|
||
### Deploy your change in realtime (each time you saved source code)
|
||
```
|
||
/vagrant/ynh-dev watch
|
||
```
|
||
|
||
### Get ip address of your vm
|
||
```
|
||
/vagrant/ynh-dev ip
|
||
```
|
||
|
||
## More info
|
||
|
||
https://yunohost.org/#/dev_fr (french)
|