Overview

Mezzanine is a powerful, consistent, and flexible content management
platform. Built using the Django framework, Mezzanine provides a
simple yet highly extensible architecture that encourages diving in
and hacking on the code. Mezzanine is BSD licensed and supported by
a diverse and active community.

In some ways, Mezzanine resembles tools such as Wordpress that
provide an intuitive interface for managing pages, blog posts, form
data, store products, and other types of content. But Mezzanine is
also different. Unlike many other platforms that make extensive use of
modules or reusable applications, Mezzanine provides most of its
functionality by default. This approach yields a more integrated and
efficient platform.

The createdb command is a shortcut for using Django's syncdb
command and setting the initial migration state for South. You
can alternatively use syncdb and migrate if preferred.
South is automatically added to INSTALLED_APPS if the
USE_SOUTH setting is set to True.

createdb will also install some demo content, such as a contact
form and image gallery. If you'd like to omit this step, use the
--nodata option with createdb.

You should then be able to browse to http://127.0.0.1:8000/admin/ and
log in using the default account (username: admin, password:
default). If you'd like to specify a different username and password
during set up, simply exclude the --noinput option included above
when running createdb.

For information on how to add Mezzanine to an existing Django project,
see the FAQ section of the documentation.

Contributing

Mezzanine is an open source project managed using both the Git and
Mercurial version control systems. These repositories are hosted on
both GitHub and Bitbucket respectively, so contributing is as
easy as forking the project on either of these sites and committing
back your enhancements.

Please note the following guidelines for contributing:

Contributed code must be written in the existing style. For Python
(and to a decent extent, JavaScript as well), this is as simple as
following the Django coding style and (most importantly)
PEP 8. Front-end CSS should adhere to the
Bootstrap CSS guidelines.

Contributions must be available on a separately named branch
based on the latest version of the main branch.

Run the tests before committing your changes. If your changes
cause the tests to break, they won't be accepted.

If you are adding new functionality, you must include basic tests
and documentation.

Here's a quick start to hacking on Mezzanine after forking it on
GitHub, by using the internal "project_template" as your current
project:

Third-party Modules

The following modules have been developed outside of Mezzanine. If you
have developed a module to integrate with Mezzanine and would like to
list it here, send an email to the mezzanine-users mailing list.
You can also add modules to the Mezzanine Grid on djangopackages.com.

Donating

If you would like to make a donation to continue development of
Mezzanine, you can do so via the Mezzanine Project website.

Support

To report a security issue, please send an email privately to
security@jupo.org. This gives us a chance to fix the issue and
create an official release prior to the issue being made
public.

For all other Mezzanine support, the primary channel is the
mezzanine-users mailing list. Questions, comments, and all related
discussions take place here amongst knowledgeable members of the
community.

If you're certain you've come across a bug, then please use the
GitHub issue tracker. It's crucial that enough information is
provided to reproduce the bug. This includes things such as the
Python stack trace generated by error pages, as well as other aspects
of the development environment used, such as operating system,
database, Python version, etc. If you're not sure you've found a
reproducable bug, then please try the mailing list first.