This is a project template for creating new websites or applications powered by the Midgard MVC framework for PHP.
This project template is designed to be used together with the Composer PHP dependency management tool. You can create new Midgard MVC projects on your current machine with:
$ composer create-project midgard/midgardmvc-project-template myproject
This will download the Midgard MVC project template and set it up together with the dependencies. This new project will be set up in the
The Midgard MVC project template follows a file structure typical for Composer-installed Midgard MVC applications:
application.ymlcontains the application configuration, including site's node hierarchy and list of enabled components
composer.jsonlists the dependencies for your application
manifest.ymlcontains routes for the site's main component (in this case
controllerscontains controllers of the main component
templatescontains templates of the main component
vendorcontains all Composer-installed dependencies, including Midgard MVC in
varcontains logs and caches used by the Vagrant setup
Vagrant gives an easy way to manage development virtual machines using Midgard MVC.
- NFS (out-of-the-box in OS X, on Debian-based Linux systems install
To set up a Vagrant project, download this project template, and then:
$ cd setup/vagrant $ vagrant up
up command will download a Ubuntu 12.10 base image, start it in VirtualBox and then use the Puppet configuration management system to set up Midgard2, PHP, AppServer-in-PHP, and your Midgard MVC project.
This setup can take a long time depending on your internet connection. Once it is done, there should be a Midgard MVC instance running based on your project setup. You can access it at http://localhost:8181.
The Vagrant VM will mount your project directory over NFS, and so all of your file changes will apply to the virtual machine instantly. If you need to tweak something on the VM, you can get an SSH connection to it with:
$ vagrant ssh
Your mounted project directory will be available in
Since AiP is a persistent PHP process, you'll need to restart it when you make changes to your files. You can do that after
vagrant ssh with:
$ sudo service midgardmvc stop $ sudo service midgardmvc start
You can use the
vagrant halt command to stop your virtual machine, and
vagrant up to restart it.
If you want to start from scratch, simply run
vagrant destroy, and rebuild the VM image with another
If you want to distribute your VM image with your team, read the Vagrant packaging documentation.