Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 1.91 KB

How to contribute

Development

This project uses LinkValue/majora-ansible-vagrant v2.2.0 as its development environment, so please head to this link and fulfill the Requirements section for your OS before anything else.

Installation

1. Clone project

git clone git@github.com:LinkValue/Appbuild.git
cd Appbuild

2. Virtual machine provisioning

make provision

Note: If it unluckily fails at some point, don't hesitate to re-run this command several times.

3. Install project

# connect to the VM
make ssh
# install the project for development (you'll have to press "Enter" several times to configure the project with default parameters)
make install

4. Enjoy

You should see your application up and running at http://local.appbuild.com/app_dev.php/

Try to login using one of the following credentials:

# login => password
superadmin@superadmin.fr => superadmin
admin@admin.fr => admin
user@user.fr => user

Frontend development

Front assets (css/js/images) are handled by Webpack.

When you're in production environment (i.e. http://local.appbuild.com/...), the project will use the assets found in web/assets, it means that you'll have to run make assets-build each time you edit an asset file to see the modification in your browser (after refreshing it manually).

When you're in development environment (i.e. http://local.appbuild.com/app_dev.php/...), you can also watch asset modifications to benefit from the hot reloading feature of webpack-dev-server, by typing the following command:

make assets-watch

Common tasks

# rebuild the whole database with clean fixtures
make db-rebuild
# update your database schema after adding/removing stuff in your data model
make db-rebuild db-update db-build
# run functional tests
bin/behat