doc/tutorials/base/index.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Thu, 02 Jun 2016 09:41:24 +0200
changeset 11285 581b5b64b382
parent 10491 c67bcee93248
permissions -rw-r--r--
[tox] Put development dependencies into a dev-requirements.txt file The latter being sourced in tox.ini. For now this contains references to hg repositories for some dependencies but under normal circumstances it should only contain pytest. This is useful when developping cubicweb itself without using tox but working with a virtualenv so that one can simply do: :: $ virtualenv --system-site-packages venv $ . venv/bin/activate $ pip install -r dev-requirements.txt $ python setup.py develop

.. -*- coding: utf-8 -*-

.. _TutosBase:

Building a simple blog with |cubicweb|
======================================

|cubicweb| is a semantic web application framework that favors reuse and
object-oriented design.


This tutorial is designed to help in your very first steps to start with
|cubicweb|. We will tour through basic concepts such as:

* getting an application running by using existing components
* discovering the default user interface
* basic extending and customizing the look and feel of that application

More advanced concepts are covered in :ref:`TutosPhotoWebSite`.


.. _TutosBaseVocab:

Some vocabulary
---------------

|cubicweb| comes with a few words of vocabulary that you should know to
understand what we're talking about. To follow this tutorial, you should at least
know that:

* a `cube` is a component that usually includes a model defining some data types
  and a set of views to display them. A cube can be built by assembling other
  cubes;

* an `instance` is a specific installation of one or more cubes and includes
  configuration files, a web server and a database.

Reading :ref:`Concepts` for more vocabulary will be required at some point.

Now, let's start the hot stuff!

.. toctree::
   :maxdepth: 2

   blog-in-five-minutes
   discovering-the-ui
   customizing-the-application
   conclusion