Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 1.53 KB

index.rst

File metadata and controls

47 lines (36 loc) · 1.53 KB

Welcome to |project|'s documentation!

Warning

This documentation is work in progress

|project| is a framework which helps building Django based database applications. |project| itself does not assume anything about the data model of your application. Instead it tries to provide common abstractions, shortcus and APIs which can be used within any Django project. While in some regards similar to :py:mod:`django:django.contrib.admin` |project| focuses much more on building a complete database system instead of a backend administration tool for websites. Therefore |project| is not API compatible with :py:mod:`django:django.contrib.admin`, unlike some other projects (see here).

A core component of |project| is the implementation of a UI system which helps creating consistent user interfaces. The implementation is based on the IBM Carbon Design System and provides most of the official carbon components.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   guide
   concepts
   recepies
   tutorial

.. toctree::
   :maxdepth: 3
   :caption: Reference:

   reference/modules

Indices and tables