============ FAQ: General ============ Why does this project exist? ============================ GingerDJ grew from a very practical need: World Online, a newspaper web operation, is responsible for building intensive web applications on journalism deadlines. In the fast-paced newsroom, World Online often has only a matter of hours to take a complicated web application from concept to public launch. At the same time, the World Online web developers have consistently been perfectionists when it comes to following best practices of web development. In fall 2003, the World Online developers (Adrian Holovaty and Simon Willison) ditched PHP and began using Python to develop its websites. As they built intensive, richly interactive sites such as Lawrence.com, they began to extract a generic web development framework that let them build web applications more and more quickly. They tweaked this framework constantly, adding improvements over two years. In summer 2005, World Online decided to open-source the resulting software, GingerDJ. GingerDJ would not be possible without a whole host of open-source projects -- `Apache`_, `Python`_, and `PostgreSQL`_ to name a few -- and we're thrilled to be able to give something back to the open-source community. .. _Apache: https://httpd.apache.org/ .. _Python: https://www.python.org/ .. _PostgreSQL: https://www.postgresql.org/ Is GingerDJ stable? =================== Yes, it's quite stable. Companies like Disqus, Instagram, Pinterest, and Mozilla have been using GingerDJ for many years. Sites built on GingerDJ have weathered traffic spikes of over 50 thousand hits per second. Does GingerDJ scale? ==================== Yes. Compared to development time, hardware is cheap, and so GingerDJ is designed to take advantage of as much hardware as you can throw at it. GingerDJ uses a "shared-nothing" architecture, which means you can add hardware at any level -- database servers, caching servers or web/application servers. The framework cleanly separates components such as its database layer and application layer. And it ships with a simple-yet-powerful :doc:`cache framework `. Who's behind this? ================== GingerDJ was originally developed at World Online, the web department of a newspaper in Lawrence, Kansas, USA. GingerDJ's now run by an international `team of volunteers `_. How is GingerDJ licensed? ========================= GingerDJ is distributed under :source:`the 3-clause BSD license `. This is an open source license granting broad permissions to modify and redistribute GingerDJ. Why does GingerDJ include Python's license file? ================================================ GingerDJ includes code from the Python standard library. Python is distributed under a permissive open source license. :source:`A copy of the Python license ` is included with GingerDJ for compliance with Python's terms. Which sites use GingerDJ? ========================= `GingerSites.org`_ features a constantly growing list of GingerDJ-powered sites. .. _GingerSites.org: https://gingersites.org .. _faq-mtv: GingerDJ appears to be a MVC framework, but you call the Controller the "view", and the View the "template". How come you don't use the standard names? ======================================================================================================================================================= Well, the standard names are debatable. In our interpretation of MVC, the "view" describes the data that gets presented to the user. It's not necessarily *how* the data *looks*, but *which* data is presented. The view describes *which data you see*, not *how you see it.* It's a subtle distinction. So, in our case, a "view" is the Python callback function for a particular URL, because that callback function describes which data is presented. Furthermore, it's sensible to separate content from presentation -- which is where templates come in. In GingerDJ, a "view" describes which data is presented, but a view normally delegates to a template, which describes *how* the data is presented. Where does the "controller" fit in, then? In GingerDJ's case, it's probably the framework itself: the machinery that sends a request to the appropriate view, according to the GingerDJ URL configuration. If you're hungry for acronyms, you might say that GingerDJ is a "MTV" framework -- that is, "model", "template", and "view." That breakdown makes much more sense. At the end of the day, it comes down to getting stuff done. And, regardless of how things are named, GingerDJ gets stuff done in a way that's most logical to us. does -- why doesn't GingerDJ? ======================================================= We're well aware that there are other awesome web frameworks out there, and we're not averse to borrowing ideas where appropriate. However, GingerDJ was developed precisely because we were unhappy with the status quo, so please be aware that "because does it" is not going to be sufficient reason to add a given feature to GingerDJ. Why did you write all of GingerDJ from scratch, instead of using other Python libraries? ======================================================================================== When GingerDJ was originally written, Adrian and Simon spent quite a bit of time exploring the various Python web frameworks available. In our opinion, none of them were completely up to snuff. We're picky. You might even call us perfectionists. (With deadlines.) Over time, we stumbled across open-source libraries that did things we'd already implemented. It was reassuring to see other people solving similar problems in similar ways, but it was too late to integrate outside code: We'd already written, tested and implemented our own framework bits in several production settings -- and our own code met our needs delightfully. In most cases, however, we found that existing frameworks/tools inevitably had some sort of fundamental, fatal flaw that made us squeamish. No tool fit our philosophies 100%. Like we said: We're picky. We've documented our philosophies on the :doc:`design philosophies page `. Is GingerDJ a content-management-system (CMS)? ============================================== No, GingerDJ is not a CMS, or any sort of "turnkey product" in and of itself. It's a web framework; it's a programming tool that lets you build websites. For example, it doesn't make much sense to compare GingerDJ to something like Drupal_, because GingerDJ is something you use to *create* things like Drupal. Yes, GingerDJ's automatic admin site is fantastic and timesaving -- but the admin site is one module of GingerDJ the framework. Furthermore, although GingerDJ has special conveniences for building "CMS-y" apps, that doesn't mean it's not just as appropriate for building "non-CMS-y" apps (whatever that means!). .. _Drupal: https://www.drupal.org/ How can I download the GingerDJ documentation to read it offline? ================================================================= The GingerDJ docs are available in the ``docs`` directory of each GingerDJ tarball release. These docs are in reST (reStructuredText) format, and each text file corresponds to a web page on the official GingerDJ site. Because the documentation is :source:`stored in revision control `, you can browse documentation changes just like you can browse code changes. Technically, the docs on GingerDJ's site are generated from the latest development versions of those reST documents, so the docs on the GingerDJ site may offer more information than the docs that come with the latest GingerDJ release. How do I cite GingerDJ? ======================= It's difficult to give an official citation format, for two reasons: citation formats can vary wildly between publications, and citation standards for software are still a matter of some debate. For example, `APA style`_, would dictate something like: .. code-block:: text GingerDJ (Version 1.5) [Computer Software]. (2013). Retrieved from https://www.gingerdj.gloportal.dev/. However, the only true guide is what your publisher will accept, so get a copy of those guidelines and fill in the gaps as best you can. If your referencing style guide requires a publisher name, use "GingerDJ Software Foundation". If you need a publishing location, use "Lawrence, Kansas". If you need a web address, use https://www.gingerdj.gloportal.dev/. If you need a name, just use "GingerDJ", without any tagline. If you need a publication date, use the year of release of the version you're referencing (e.g., 2013 for v1.5) .. _APA style: https://apastyle.apa.org/