MonarcAppFO/vagrant/README.rst

Development environment for MONARC
==================================

Vagrant is convenient to use in order to setup your development environment.

This VM uses `synced folders <https://www.vagrantup.com/docs/synced-folders/>`_
feature of Vagrant in order to let you work on the MONARC source code on your
host machine while the softwares (Apache, PHP, MariaDB, etc.) and libraries
will be installed on the guest Vagrant machine.


Installation of VirtualBox and Vagrant
--------------------------------------

.. code-block:: bash

    $ sudo apt-get install virtualbox vagrant
    $ vagrant plugin install vagrant-disksize


Deployment of the front office
------------------------------

MONARC will be automatically deployed in an Ubuntu Bionic Server.

.. code-block:: bash

    $ git clone https://github.com/monarc-project/MonarcAppFO
    $ cd MonarcAppFO/vagrant
    $ vagrant up

Once the VM will be configured by Vagrant, go to the address
http://127.0.0.1:5001.

The username is *admin@admin.localhost* and the password is *admin*.

You can now edit the source code with your favorite editor and test it in your
browser. The only thing is to not forget to restart Apache in the VM after a
modification.

------------------------------
Run tests.
The test can be run from Monarc root folder (/home/ubuntu/monarc) of your vagrant VM (params in square brackets are optional):

sudo ./bin/phpunit [--testsuite Functional | --testsuite Integration | --testsuite Unit]

In case of changing the DB configuration (tests/local.php) you can run them from your host machine.