0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
A Django content management system focused on flexibility and user experience https://wagtail.org/
Go to file
2014-07-04 16:14:42 +01:00
.tx Finished string extraction for i18n 2014-02-21 17:57:00 +02:00
docs Merge pull request #419 from gasman/serve_preview 2014-07-03 17:22:22 +01:00
scripts/install Installation comment to address wagtail issue 220. 2014-05-27 16:54:06 +01:00
wagtail Added assertRegex to WagtailTestUtils 2014-07-04 16:14:42 +01:00
.coveragerc Added 'return NotImplemented' to list of ignored lines in coverage 2014-02-23 17:31:04 +00:00
.gitignore Revert "Merge pull request #335 from mope/edit-handlers-unit-tests" 2014-06-24 12:53:34 +01:00
.travis.yml Added python 3.2 to travis settings 2014-07-02 22:02:07 +01:00
CHANGELOG.txt Updated changelog 2014-07-03 13:07:18 +01:00
CONTRIBUTORS.rst Update CONTRIBUTORS.rst 2014-06-25 10:21:38 +01:00
LICENSE Add an initially empty django-wagtail package 2014-01-22 12:27:23 +00:00
Makefile add a general test runner for wagtail, accessible by running './runtests.py' or 'make test' from the wagtail repo, or 'manage.py test wagtail' from a django project such as wagtaildemo 2014-02-13 12:44:49 +00:00
MANIFEST.in include new top-level text files in manifest 2014-02-07 15:57:54 +00:00
README.rst Merge branch 'python3-take2-unicode-literals' of https://github.com/kaedroho/wagtail into kaedroho-python3-take2-unicode-literals 2014-07-03 11:51:03 +01:00
requirements-dev.txt Bump flake8 to correct latest version. 2014-07-02 17:47:03 +01:00
runtests.py Use UTC timezone in tests 2014-07-03 13:44:11 +01:00
setup.py Added a couple of missing python version classifiers 2014-07-03 13:06:32 +01:00
tox.ini add py32-dj16-sqlite to the list of tox environments that fail due to iteritems in South 2014-07-03 12:11:34 +01:00

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master
    :target: https://travis-ci.org/torchbox/wagtail

.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.png?branch=master&zxcv1
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master

.. image:: https://pypip.in/v/wagtail/badge.png?zxcv
    :target: https://crate.io/packages/wagtail/

Wagtail CMS
===========

.. image:: http://i.imgur.com/4pbWQ35.png

Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ and focused on flexibility and user experience. Its features include:

* A fast, attractive editor interface
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Tightly integrated search (with an `Elasticsearch <http://www.elasticsearch.org/>`_ backend for production)
* Strong document and image management
* Wide support for embedded content
* Simple, configurable permissions
* Support for tree-based content organisation
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
* A simple `form builder <http://docs.wagtail.io/en/latest/form_builder.html>`_
* Optional `static site generation <http://docs.wagtail.io/en/latest/static_site_generation.html>`_
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_

Find out more at `wagtail.io <http://wagtail.io/>`_.

Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.

Getting started
~~~~~~~~~~~~~~~
* To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions.
* See the `Getting Started <http://wagtail.readthedocs.org/en/latest/gettingstarted.html#getting-started>`_ docs for installation (with the demo app) on a fresh Debian/Ubuntu box with production-ready dependencies, on OS X and on a Vagrant box.
* `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.
* We've also provided a skeletal django-template to get started on a blank site: https://github.com/torchbox/wagtail-template

Documentation
~~~~~~~~~~~~~
Available at `wagtail.readthedocs.org <http://wagtail.readthedocs.org/>`_ and always being updated.

Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.6.2+ on Python 2.6, 2.7, 3.2, 3.3 and 3.4.

Django 1.7 support is in progress pending further release candidate testing.

Wagtail's dependencies are summarised at `requirements.io <https://requires.io/github/torchbox/wagtail/requirements>`_.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in!

We suggest you start by checking the `Help develop me! <https://github.com/torchbox/wagtail/issues?labels=Help+develop+me%21>`_ label.

Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_.