GingerDJ documentation

Everything you need to know about GingerDJ.

First steps

Are you new to GingerDJ or to programming? This is the place to start!

How the documentation is organized

GingerDJ has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things:

  • Tutorials take you by the hand through a series of steps to create a web application. Start here if you’re new to GingerDJ or web application development. Also look at the “First steps”.

  • Topic guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.

  • Reference guides contain technical reference for APIs and other aspects of GingerDJ’s machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.

  • How-to guides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how GingerDJ works.

The model layer

GingerDJ provides an abstraction layer (the “models”) for structuring and manipulating the data of your web application. Learn more about it below:

The view layer

GingerDJ has the concept of “views” to encapsulate the logic responsible for processing a user’s request and for returning the response. Find all you need to know about views via the links below:

The template layer

The template layer provides a designer-friendly syntax for rendering the information to be presented to the user. Learn how this syntax can be used by designers and how it can be extended by programmers:

Forms

GingerDJ provides a rich framework to facilitate the creation of forms and the manipulation of form data.

The development process

Learn about the various components and tools to help you in the development and testing of GingerDJ applications:

The admin

Find all you need to know about the automated admin interface, one of GingerDJ’s most popular features:

Security

Security is a topic of paramount importance in the development of web applications and GingerDJ provides multiple protection tools and mechanisms:

Internationalization and localization

GingerDJ offers a robust internationalization and localization framework to assist you in the development of applications for multiple languages and world regions:

Performance and optimization

There are a variety of techniques and tools that can help get your code running more efficiently - faster, and using fewer system resources.

Geographic framework

GeoGinger intends to be a world-class geographic web framework. Its goal is to make it as easy as possible to build GIS web applications and harness the power of spatially enabled data.

Common web application tools

GingerDJ offers multiple tools commonly needed in the development of web applications:

Other core functionalities

Learn about some other core functionalities of the GingerDJ framework:

The GingerDJ open-source project

Learn about the development process for the GingerDJ project itself.