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
Karl Hobley 10c65d6881 Refactor meta serialisation
This is preparation for implementing better customisation of the meta section (allowing user fields to be added here).

All meta field classes have been broken down into parts. So DocumentMetaField/PageMetaField/etc have been broken down to TypeField, DetailUrlField, etc.

I have made the following public-facing changes to the API along the way:
 - page "parent" field has moved into meta
 - page "parent" is always present now, it will be serialised to null on homepages instead of disappearing
 - Child relations now have id and meta
2016-03-01 13:12:24 +00:00
.tx Added transifex config for wagtailstyleguide 2015-08-26 15:07:39 +01:00
client Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
docs Changelog/release note/contributor for #2279 2016-03-01 12:32:09 +00:00
etc etc: add sample uwsgi and nginx configuration files 2015-05-01 15:02:29 +01:00
gulpfile.js Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
scripts Pin jscs version on Drone 2016-01-04 11:44:28 +00:00
wagtail Refactor meta serialisation 2016-03-01 13:12:24 +00:00
.babelrc Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.coveragerc Update .coveragerc 2015-12-23 00:09:44 +01:00
.drone.yml Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.eslintignore Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.eslintrc Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.gitignore Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.scss-lint.yml removed unnecessary whitelist of sass files to compile. sass knows not to compile partials, which leaves all the _other_ files which it should compile 2015-12-04 10:54:38 +00:00
.travis.yml fixed travis file 2016-02-11 07:22:56 +13:00
CHANGELOG.txt Changelog/release note/contributor for #2279 2016-03-01 12:32:09 +00:00
CODE_OF_CONDUCT.md Add Contributor Covenant 2016-02-03 15:47:50 +00:00
CONTRIBUTING.md Create CONTRIBUTING.md 2016-02-03 07:59:29 +00:00
CONTRIBUTORS.rst Changelog/release note/contributor for #2279 2016-03-01 12:32:09 +00: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
package.json Add missing dependencies to package.json 2016-02-25 17:34:15 +02:00
README.rst Merge pull request #2094 from tony/patch-1 2016-01-08 14:30:29 +00:00
requirements-dev.txt Moved all dev dependencies into setup.py 2016-02-05 14:44:51 +00:00
runtests.py Added --elasticsearch argument to runtests.py 2015-11-09 12:13:07 +00:00
setup.cfg Use universal wheel files 2015-06-03 10:08:21 +01:00
setup.py Moved all dev dependencies into setup.py 2016-02-05 14:44:51 +00:00
tox.ini Removed django-compressor 2016-02-03 16:16:11 +00:00
webpack.base.config.js Fix webpack aliasing for config module 2016-02-25 17:36:27 +02:00
webpack.dev.config.js Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
webpack.prd.config.js Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00

.. image:: https://api.travis-ci.org/torchbox/wagtail.svg?branch=master
    :target: https://travis-ci.org/torchbox/wagtail
.. image:: https://img.shields.io/pypi/l/wagtail.svg
    :target: https://pypi.python.org/pypi/wagtail/
.. image:: https://img.shields.io/pypi/v/wagtail.svg
    :target: https://crate.io/packages/wagtail/
.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master

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

Wagtail is a content management system built on Django. It's focused on user experience,
and offers precise control for designers and developers.

.. image:: http://i.imgur.com/U5MDa0l.jpg
   :width: 728 px

Features
~~~~~~~~

* A fast, attractive interface for authors and editors
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Fast out of the box. Cache-friendly if you need it
* Tightly integrated search
* Strong document and image management
* Wide support for embedded content
* Straightforward integration with existing Django apps
* Simple, configurable permissions
* Workflow support
* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms.html>`_
* Multi-site and multi-language support
* Optional `static site generation <http://docs.wagtail.io/en/latest/reference/contrib/staticsitegen.html>`_
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_

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

Getting started
~~~~~~~~~~~~~~~

.. code-block:: sh

    pip install wagtail
    wagtail start mysite
    cd mysite
    python manage.py migrate
    python manage.py createsuperuser
    python manage.py runserver

then sign in at http://127.0.0.1:8000/admin/

For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.

Who's using it?
~~~~~~~~~~~~~~~
`madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.

Documentation
~~~~~~~~~~~~~
`docs.wagtail.io <http://docs.wagtail.io/>`_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.

Community Support
~~~~~~~~~~~~~~~~~
Ask your questions on our `Wagtail support group <https://groups.google.com/forum/#!forum/wagtail>`_.

Commercial Support
~~~~~~~~~~~~~~~~~~
Wagtail is sponsored by `Torchbox <https://torchbox.com/>`_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.

Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.8.1+ on Python 2.7, 3.3, 3.4 and 3.5. Supported database backends are PostgreSQL, MySQL and SQLite.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).

You might like to start by reviewing the `coding guidelines <http://docs.wagtail.io/en/latest/contributing/developing.html#coding-guidelines>`_ and checking issues with the `Ready to develop <https://github.com/torchbox/wagtail/issues?q=is%3Aopen+is%3Aissue+label%3A%22Ready+to+develop%21%22>`_ label.

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

We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.