.. Springboard documentation master file, created by
   sphinx-quickstart on Thu Jan 29 15:33:20 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Springboard's documentation!
=======================================

Springboard is a library and command line tool for scaffolding and
bootstrapping sites for Universal Core.

.. image:: https://travis-ci.org/universalcore/springboard.svg?branch=develop
    :target: https://travis-ci.org/universalcore/springboard
    :alt: Continuous Integration

.. image:: https://coveralls.io/repos/universalcore/springboard/badge.png?branch=develop
    :target: https://coveralls.io/r/universalcore/springboard?branch=develop
    :alt: Code Coverage

.. image:: https://readthedocs.org/projects/springboard/badge/?version=latest
    :target: https://springboard.readthedocs.org
    :alt: Springboard Documentation

.. image:: https://pypip.in/version/springboard/badge.svg
    :target: https://pypi.python.org/pypi/springboard
    :alt: Pypi Package


.. image:: springboard.gif

Installation
============

.. code-block:: bash

    pip install springboard

Starting a new site
===================

First make sure you have Elasticsearch_ installed and running, then:

.. code-block:: bash

    $ springboard startapp myapp
    $ cd myapp
    $ springboard import https://github.com/universalcore/unicore-cms-content-ffl-tanzania -v
    $ pserve development.ini --reload

    Starting server in PID 70411.
    serving on http://0.0.0.0:6543

Now visit http://0.0.0.0:6543/ in your browser and see the skeleton site
with the content loaded from the repository.

The templates and the static files used the render and style the content
are in the ``myapp/templates`` and ``myapp/static`` directories.

Have fun!

Springboard installs with a few more command line tools that make it
easy to clone, index, map & sync the data. Have a look at the :ref:`tools`
documentation


.. _Elasticsearch: http://www.elasticsearch.org
.. _Redis: http://www.redis.io