Metadata-Version: 2.0
Name: django-icekit
Version: 0.14
Summary: A modular content CMS by Interaction Consortium.
Home-page: https://github.com/ic-labs/django-icekit
Author: Interaction Consortium
Author-email: studio@interaction.net.au
License: MIT
Platform: UNKNOWN
Requires-Dist: Pillow
Requires-Dist: django-any-urlfield
Requires-Dist: django-app-namespace-template-loader
Requires-Dist: django-bootstrap3
Requires-Dist: django-compressor
Requires-Dist: django-el-pagination
Requires-Dist: django-extensions
Requires-Dist: django-fluent-contents
Requires-Dist: django-fluent-pages
Requires-Dist: django-model-settings
Requires-Dist: django-mptt (!=0.8.5)
Requires-Dist: django-multiurl
Requires-Dist: django-polymorphic
Requires-Dist: django-wysiwyg
Requires-Dist: html5lib (==0.999)
Requires-Dist: nltk
Requires-Dist: requests
Requires-Dist: unidecode
Provides-Extra: api
Requires-Dist: djangorestframework; extra == 'api'
Provides-Extra: brightcove
Requires-Dist: django-brightcove; extra == 'brightcove'
Provides-Extra: dev
Requires-Dist: Werkzeug; extra == 'dev'
Requires-Dist: django-debug-toolbar; extra == 'dev'
Requires-Dist: ipdb; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: mkdocs; extra == 'dev'
Provides-Extra: django18
Requires-Dist: Django (>=1.8,<1.9); extra == 'django18'
Provides-Extra: forms
Requires-Dist: django-forms-builder; extra == 'forms'
Provides-Extra: project
Requires-Dist: ConcurrentLogHandler; extra == 'project'
Requires-Dist: Jinja2; extra == 'project'
Requires-Dist: boto (<=2.27); extra == 'project'
Requires-Dist: celery[redis]; extra == 'project'
Requires-Dist: django-celery; extra == 'project'
Requires-Dist: django-celery-email; extra == 'project'
Requires-Dist: django-extensions; extra == 'project'
Requires-Dist: django-flat-theme (<1.1.3); extra == 'project'
Requires-Dist: django-fluent-contents[markupoembeditemtext]; extra == 'project'
Requires-Dist: django-fluent-pages[redirectnodereversion]; extra == 'project'
Requires-Dist: django-master-password; extra == 'project'
Requires-Dist: django-polymorphic-auth; extra == 'project'
Requires-Dist: django-post-office; extra == 'project'
Requires-Dist: django-redis; extra == 'project'
Requires-Dist: django-reversion (<1.10,>=1.9.3); extra == 'project'
Requires-Dist: django-storages (<1.2); extra == 'project'
Requires-Dist: django-test-without-migrations; extra == 'project'
Requires-Dist: django-timezone; extra == 'project'
Requires-Dist: docutils; extra == 'project'
Requires-Dist: easy-thumbnails; extra == 'project'
Requires-Dist: flower; extra == 'project'
Requires-Dist: gunicorn; extra == 'project'
Requires-Dist: icekit-notifications; extra == 'project'
Requires-Dist: ixc-django-compressor; extra == 'project'
Requires-Dist: ixc-whitenoise; extra == 'project'
Requires-Dist: psycopg2; extra == 'project'
Requires-Dist: python-redis-lock[django]; extra == 'project'
Requires-Dist: pytz; extra == 'project'
Requires-Dist: raven; extra == 'project'
Requires-Dist: supervisor; extra == 'project'
Provides-Extra: search
Requires-Dist: django-fluent-pages[fluentpage,flatpage]; extra == 'search'
Requires-Dist: django-haystack; extra == 'search'
Requires-Dist: elasticsearch; extra == 'search'
Requires-Dist: elasticstack; extra == 'search'
Provides-Extra: test
Requires-Dist: WebTest; extra == 'test'
Requires-Dist: celery[redis]; extra == 'test'
Requires-Dist: coverage; extra == 'test'
Requires-Dist: coveralls; extra == 'test'
Requires-Dist: django-dynamic-fixture; extra == 'test'
Requires-Dist: django-nose; extra == 'test'
Requires-Dist: django-webtest; extra == 'test'
Requires-Dist: djangorestframework; extra == 'test'
Requires-Dist: micawber; extra == 'test'
Requires-Dist: mock; extra == 'test'
Requires-Dist: nose-progressive; extra == 'test'
Requires-Dist: psycopg2; extra == 'test'

|Build Status| |Coverage Status| |Documentation| |Version|

|Deploy to Docker Cloud|

ICEkit is a next-generation CMS by `the Interaction
Consortium <http://interaction.net.au>`__, built on top of
`django-fluent-pages <https://github.com/edoburu/django-fluent-pages>`__
and
`django-fluent-contents <https://github.com/edoburu/django-fluent-contents>`__.
See `ICEkit features at a glance <docs/intro/features.md>`__.

ICEkit underpins `GLAMkit <http://glamkit.org>`__ and many individual
sites.

Quickstart, with Docker
=======================

.. raw:: html

   <!-- keep identical with docs/intro/install.md, except for link relativity. -->

If you haven't already, install `Docker <docs/intro/docker.md>`__:

-  `OS X <https://download.docker.com/mac/stable/Docker.dmg>`__
-  `Linux <https://docs.docker.com/engine/installation/linux/>`__
-  `Windows <https://download.docker.com/win/stable/InstallDocker.msi>`__

Docker works on OS X, Linux, and Windows, takes care of all the project
dependencies (e.g. database, search engine, web server, etc.), and makes
`deployment <docs/howto/deployment.md>`__ easy.

If you're not ready for Docker, see `Manual
Setup <docs/intro/manual-setup.md>`__.

1. Create a new project
-----------------------

::

    $ bash <(curl -Ls https://raw.githubusercontent.com/ic-labs/django-icekit/master/icekit/bin/startproject.sh) <project_name>

This will create a new project from the ICEkit project template, in a
directory named in the current working directory.

NOTE: Windows users should run this command in Git Bash, which comes
with `Git for Windows <https://git-for-windows.github.io/>`__.

2. Run the project
------------------

Build a Docker image:

::

    $ cd <project_name>
    $ docker-compose build --pull

Run a ``django`` container and all of its dependancies:

::

    $ docker-compose run --rm --service-ports django

Create a superuser account:

::

    # manage.py createsuperuser

Run the Django dev server:

::

    # runserver.sh

3. That's it!
-------------

Open the site in a browser:

::

    http://localhost:8000

When you're done, exit the container and stop all of its dependencies:

::

    # exit
    $ docker-compose stop

Next steps
==========

-  `Start building your site <docs/howto/start.md>`__
-  `Architectural overview <docs/intro/architecture.md>`__
-  `Read the Documentation <http://icekit.readthedocs.io>`__

.. raw:: html

   <!-- editors guide -->

.. |Build Status| image:: https://img.shields.io/travis/ic-labs/django-icekit.svg
   :target: https://travis-ci.org/ic-labs/django-icekit
.. |Coverage Status| image:: https://img.shields.io/coveralls/ic-labs/django-icekit.svg
   :target: https://coveralls.io/github/ic-labs/django-icekit
.. |Documentation| image:: https://readthedocs.org/projects/icekit/badge/
   :target: https://icekit.readthedocs.io/
.. |Version| image:: https://img.shields.io/pypi/v/django-icekit.svg
   :target: https://pypi.python.org/pypi/django-icekit
.. |Deploy to Docker Cloud| image:: https://files.cloud.docker.com/images/deploy-to-dockercloud.svg
   :target: https://cloud.docker.com/stack/deploy/


