webdesigntiger / wagtail-cookiecutter-foundation

A Cookiecutter template for Wagtail CMS using Zurb Foundation 6

Home Page:http://wagtail.chrisdev.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wagtail Cookiecutter Foundation

Updates

image

A cookiecutter template for Wagtail CMS was built using Zurb Foundation front-end framework. A demo of a default project generated from this cookiecutter is available at http://wagtail.chrisdev.com.

Read the Docs: http://wagtail-cookiecutter-foundation.readthedocs.org/en/latest/

Features

A Django project with Wagtail CMS pre-installed with support for all the Zurb Foundation components.

  • For Django 1.9
  • Renders Django projects with 100% starting test coverage
  • Zurb Foundation
  • 12-Factor based settings via django-environ
  • Optimized development and production settings
  • Built with Let's Encrypt
  • Comes with custom user model ready to go
  • Grunt build for compass and livereload
  • Ansible support for development and production
  • Works with Python 2.7.x or 3.5.x

Getting Started

Here is how we create a new Django project quickly while letting cookiecutter to do all the work.

To get started we assume the following dependencies :

pip
virtualenv/pyvenv/virtualenvwrapper
PostgreSQL
Bower

Get Cookiecutter :

$ pip install cookiecutter

Now run it against this repo:

$ cookiecutter https://github.com/chrisdev/wagtail-cookiecutter-foundation.git

You'll be prompted for some values. Provide them, then a Django project will be created for you :

Cloning into 'wagtail-cookiecutter-foundation'...
remote: Counting objects: 5355, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 5355 (delta 4), reused 0 (delta 0), pack-reused 5345
Receiving objects: 100% (5355/5355), 11.77 MiB | 4.39 MiB/s, done.
Resolving deltas: 100% (3008/3008), done.
Checking connectivity... done.
project_name [Wagtail Project]: 
repo_name [wagtail_project]: 
Select version_control_system:
    1 - git
    2 - hg
    Choose from 1, 2 [1]:
Select vcs_host:
    1 - bitbucket.org
    2 - github.com
    Choose from 1, 2 [1]: 
vcs_repo_username [your_bitbucket_or_github_user_name]: 
author_name [Christopher Clarke]: 
email [cclarke@chrisdev.com]: 
description [A short description of the project.]: 
timezone [UTC]: 
production_host_name [wagtail.chrisdev.com]: 
version [0.1.0]: 
use_letsencrypt [y]: 
use_celery [y]: 
use_opbeat [n]: 
use_django_cachalot [n]: 
staging_host_name [wagtail-staging.chrisdev.com]: 
use_vagrant_staging [True]: 
deploy_user_name [django]: 
django_admin_user [my_wagtail_admin]: 
Select open_source_license:
    1 - MIT
    2 - BSD
    3 - Apache Software License 2.0
    4 - Not open source
    Choose from 1, 2, 3, 4 [1]:

Enter the project :

$ cd wagtail_project/

Create a git repo and push it there:

$ git init
$ git add .
$ git commit -m "first awesome commit"
$ git remote add origin git@github.com:cclarke/my_site.git
$ git push -u origin master

To create your project's virtual environment, install all pip dependencies, create the development database, run migrations and load initial data to database, install front-end dependencies and finally start the development server for you run :

make all

You can access your site at http://localhost:8000. The Admin back-end is available at http://localhost:8000/admin/.The default Admin username is admin and The default Admin password is admin123.

App Modules

We provide a comprehensive suite of apps to use for building your site. We take a modular approach so that can pick and choose the functionality you want to include. We provide separate modules for:

  • pages - Different pages including Homepage, Standard & Faqs Page etc.
  • blog - Blog or site news
  • contact - Contact Page with included contact us form
  • documents_gallery - Organize documents in folders using wagtail tags
  • events - Events
  • people - For the people in your organization or team.
  • photo_gallery - Create photo galleries using wagtail tags
  • products - Ideal for a product or portfolio showcase
  • faq - FAQ and answers.
  • utils - Various utility functions, templatetags and filters

Contributing

Contributions are always welcome to improve this project. If you think you've found a bug or are interested in contributing fork this project and send the pull request. After review, your pull request will be merged. We are always happy to receive pull requests. If you identify any issue, please raise it in the issues section.

About

A Cookiecutter template for Wagtail CMS using Zurb Foundation 6

http://wagtail.chrisdev.com

License:MIT License


Languages

Language:Python 56.6%Language:HTML 26.8%Language:CSS 8.1%Language:Makefile 3.7%Language:Batchfile 1.8%Language:Ruby 1.3%Language:JavaScript 1.1%Language:Shell 0.5%