Wutta Tutorial
==============

This is a tutorial for building an app using `Wutta Framework`_.

.. _Wutta Framework: https://wuttaproject.org

It splits things into 2 main parts:

First is the "Basic Setup" which is meant to be useful for any new
project.

Second is the "Custom App" - which shows how to go about building with
the framework.  For now that is a simple gas mileage tracker app;
hopefully in the future more examples will be added.

.. note::

   All examples here use *Poser* as the project name.

   **It is literally a placeholder - you should use a different name!**

   To help differentiate things somewhat, here are all the names used:

   * Poser - human-friendly project name
   * ``poser`` - Python package name (and the source folder name)
   * ``poserdb`` - name of the app database
   * ``poserenv`` - root folder name of the Python virtual environment

   Also, examples show the virtual environment at ``~/poserenv`` and
   the project source at ``~/src/poser`` - you should adjust both
   paths according to your preference.


.. toctree::
   :maxdepth: 2
   :caption: Basic Setup:

   setup/create-project
   setup/create-database
   setup/app-install
   setup/run-webapp
   setup/get-acquainted


.. toctree::
   :maxdepth: 2
   :caption: Mileage App:

   mileage/index