Charles edited this page Dec 16, 2017 · 4 revisions

1. Prerequisites

Install the following prerequisite applications:

  1. Oracle VirtualBox

  2. Vagrant

  3. GitHub Desktop

2. Clone the repository

Use either the GitHub Desktop Application, or the command line to get the ChurchCRM code onto your development machine:

  • GitHub Desktop

  • Command Line:

    git clone

3. Start Vagrant

Vagrant takes care of building a VM with the proper prerequisutes and other configuration as specified by the ChurchCRM Project maintainers. We use a customized image based on Ubuntu 16.04 LTS to provide a a quick LAMP stack in the Vagrant environment with all of our development dependencies pre-installed

vagrant up

4. Go!

Vagrant creates a mapped directory from the source code (locally on your computer) to the virtualized web server.
This means that you can edit files directly on your machine, and the changes are live as soon as you reload the page.

Access the Project at

User: Admin Password: changeme

Database Access

See for connection info

CRM DB info

DB: churchcrm DB User: churchcrm DB Password: churchcrm

Vagrant Database Access

  • You can use a MySQL development platform, or your favorite IDE to access the ChurchCRM databases.
  • As part of the vagrant development environment, MySQL is configured to listen on all interfaces, and the churchcrm user is allowed to login from any host.

Vagrant Email

  • All outbound email from ChurchCRM should be directed at the local instance of MailCatcher.
    • MailCatcher prevents messages from actually being delivered over the Internet, but still allows you (as a developer) to see all of the headers and content of the messages
  • The SMTP service listens on, port 1025 (You must manually configure your development instance of ChurchCRM to send mail to this address.)
  • The Vagrant script will automatically start MailCatcher on all IP addresses owned by the Vagrant VM.
  • You can view (in real time) the messages sent by ChurchCRM by opening on the machine hosting the Vagrant environment

Propel Model update

  • Make changes to propel/schema.xml
  • change dir to the project root or in vagrant /vagrant
  • npm run orm-gen
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.