generator-wagtail

Yeoman generator to get you up and running with a fresh copy of Wagtail CMS, running in their official Vagrant box with all dependencies installed and ready to rock.

TODO

• [x] better instructions for setting up environment
• [x] chmod +x manage.py
• [x] Update to wagtail 1.4
• [x] more thorough tests
• [x] default projectName to current dir name (replace dashes & toLower)
• [ ] configurable database
• [ ] optionally install wagtail demo app (or split to a new repo)
• [ ] subgenerators

Prerequisites

• ~~Python 2.7 & (hopefully) virtualenv + virtualenvwrapper~~ Not required on base machine, that's the point! Vagrant will set up a box with the correct version of everything installed.
• Node.js
• Vagrant

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Wagtail generator

To install generator-wagtail from npm, run:

$ npm install -g generator-wagtail

Finally, cd to your new project directory and initiate the generator:

$ yo wagtail

Yeoman will ask you a few questions, then leave you with the base structure for a new Wagtail CMS project. You will then want to:

• vagrant up to provision your local vagrant box (may take quite some time to download the base box if this is your first run)
• vagrant ssh to log in to your vagrant box
• Once inside your vagrant box, dj createsuperuser to create an admin for your new site
• djrun in your vagrant session, then visit http://localhost:8111 on your host browser to view your freshly-baked homepage!

Attribution

Full credit to the amazing team at wagtail for creating such a beatiful CMS. Most settings have been adapted from wagtail-template

License

The MIT License (MIT)

Copyright (c) [2014] [David John Smith]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.