wagtail/vagrant-wagtail-develop

Name: vagrant-wagtail-develop

Owner: Wagtail

Description: A script to painlessly set up a Vagrant environment for development of Wagtail

Created: 2015-05-21 15:09:40.0

Updated: 2017-05-20 23:26:19.0

Pushed: 2017-12-04 22:59:00.0

Homepage: null

Size: 23

Language: Shell

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

vagrant-wagtail-develop

A script to painlessly set up a Vagrant environment for development of Wagtail.

Features

• Checkouts of Wagtail, bakerydemo, django-modelcluster and Willow ready to develop against
• Node.js / npm toolchain for front-end asset building
• Optional packages installed (PostgreSQL, ElasticSearch, Embedly, Sphinx…)
• Virtualenv for Python 3

This script currently uses a wagtail-2.0 branch of bakerydemo to test breaking changes in Wagtail 2.0.

Setup

Requirements: VirtualBox and Vagrant.

Open a terminal and follow those instructions:

 Decide where to put the project. We use "~/Development" in our examples.
/Development
 Clone the vagrant-wagtail-develop repository in a new "wagtail-dev" folder.
clone git@github.com:wagtail/vagrant-wagtail-develop.git wagtail-dev
 Move inside the new folder.
agtail-dev/
 Run the setup script. This will set up all required dependencies for you.
tup.sh

Note: On platforms that can't run shell scripts, run the commands from setup.sh manually instead.

It can take a while (typically 15-20 minutes) to fetch and build all dependencies - you could go for a coffee in the meantime :)

Here is the resulting folder structure:

libs          # Supporting libraries to develop Wagtail against.
vagrant       # Vagrant-related files.
wagtail       # Wagtail repository / codebase.
bakerydemo    # Wagtail Bakery project used for development.

Once setup is over,

 ssh into your new Vagrant virtual machine.
ant ssh
 Start up the bakerydemo development server.
nage.py runserver 0.0.0.0:8000
ccess!

• Visit your site at http://localhost:8000
• The admin interface is at http://localhost:8000/admin/ - log in with admin / changeme.

What you can do

Note: all of those commands are meant to be used inside the Vagrant virtual machine. To get there, go to your local Wagtail (cd ~/Development/wagtail-dev) set up and vagrant up then vagrant ssh.

Start the bakerydemo server:

nage.py runserver 0.0.0.0:8000
en visit http://localhost:8000 in your browser.

Run the tests:

home/vagrant/wagtail
thon tests.
ntests.py
de tests.
run test

Run the linting:

home/vagrant/wagtail
thon linting.
 lint
vaScript linting.
run lint

Build front-end assets:

home/vagrant/wagtail
run build

Start front-end development tools and file watching:

home/vagrant/wagtail
run start

Build the documentation:

home/vagrant/wagtail/docs
 html

Getting ready to contribute

Here are other actions you will likely need to do to make your first contribution to the project.

Set up git remotes to Wagtail forks (run these lines outside of the Vagrant VM):

/Development/wagtail-dev/wagtail
ange the default origin remote to point to your fork.
remote set-url origin git@github.com:<USERNAME>/wagtail.git
d wagtail/wagtail as the "upstream" remote.
remote add upstream git@github.com:wagtail/wagtail.git
d springload/wagtail as the "springload" remote.
remote add springload git@github.com:springload/wagtail.git
d gasman/wagtail as the "gasman" remote.
remote add gasman git@github.com:gasman/wagtail.git
ll latest changes from all remotes / forks.
pull --all