Made with Wagtail

A showcase of sites and apps made with Wagtail: an easy to use, open source content management system from Torchbox.

Check out Awesome Wagtail for more awesome packages and resources from the Wagtail community.

Installation

Install Vagrant and VirtualBox, then from the command-line:

git clone [email protected]:springload/madewithwagtail.git
cd madewithwagtail
vagrant up
# [.. wait until everything gets installed]
vagrant ssh
# [.. from your vagrant machine]
djrun

The demo site will now be accessible at http://localhost:8111/ and the Wagtail admin interface at http://localhost:8111/admin/ . Log into the admin with the credentials admin / changeme.

Front-end installation

Install Node. This project also uses nvm.

To install our dependencies:

nvm install
# Then, install all project dependencies.
npm install

Working on the project

Everything mentioned in the installation process should already be done.

Starting the server

vagrant up
vagrant ssh
djrun

Front-end commands

# Make sure you use the right node version.
nvm use
# Start the server and the development tools.
npm run start
# Builds frontend assets.
npm run build
# Runs linting.
npm run lint
# Runs tests.
npm run test
# View other available commands with:
npm run

Adding and upgrading dependencies

This project is shrinkwrapped. Its dependencies are locked down in npm-shrinkwrap.json file. To update them,

1. Use npm run lint:versions to confirm you are using the right node version.
2. Use npm install <package> with --save or --save-dev options to change the dependencies.
3. Check the project still works with the new dependencies / new versions.
4. Run npm run lock to regenerate npm-shrinkwrap.json.
5. Commit this file, and push.

Deploying a new version

To production

npm run deploy

From your local machine, it's a good idea to push to the master before pushing to the deploy branch. That way you know that both are up to date.

Documentation

Browser support

Supported browser / device versions:

Browser	Device/OS	Version
Mobile Safari	iOS Phone	latest
Mobile Safari	iOS Tablet	latest
Chrome	Android	latest
IE	Desktop	11
Chrome	Desktop	latest
Firefox	Desktop	latest
Safari	OSX	latest

New site submissions workflow

Anyone can submit a site on the submission form. When a new site is submitted, the details are saved and also sent to us via an email notification. We then need to manually validate the submission and add the new site via the CMS.

• Check that the submission is valid (see below)
• If the submission isn't valid, we won't add the site to our showcase. Remove it from the CMS.
• If the submission is valid,

1. Take a 1440x1200 screenshot of the site's homepage with screenshotron.
2. Log into the CMS at http://madewithwagtail.org/admin/login
3. Check if the developer already has a page in the CMS.
4. If not, create a page for the company or individual with their details.
5. Add a new Site page under this Developer, with the details that are in the submission.
6. Use the screenshot for the "Desktop image".
7. Add tags that you deem appropriate, depending on the ones we already have and the characteristics of the site.
8. Publish!
9. Let the submitter know by sending them a nice email.

Validating submissions

A site is accepted for inclusion on Made with Wagtail if it is made with Wagtail. It's that simple – there is no judgement of a site's quality. In the future, we may change how sites are displayed so some are more prominently visible than others.

To confirm that a site is made with Wagtail,

• Try to go to <site URL>/admin/. If the site uses the default admin URLs, it will redirect you to the Wagtail login page.
• Use the Wappalyzer browser extension. It won't flag Wagtail directly, but it can flag Django / Python, and could also uncover other technologies.
• Look at the homepage HTML to see if static assets are served from /static/, a common URL structure of Django sites.
• If all of those methods are inconclusive, assume that the site submission is faithful and that the site is indeed built with Wagtail.

Publication hook

We send Slack notifications for every new site page published to Made with Wagtail. To try this locally, set up a local.py setting override with the right settings.