Source

django-in-a-box / docs / index.md

Django-in-a-Box documentation

You should begin by reading the Concepts page.

Once you’re familiar with the concepts which Django-in-a-Box (DiaB) is based upon, you should move onto the directory layout documentation so you know where everything goes and where to look for certain things. The Tools section will give you information on the tools which DiaB comes with by default, and the etc/ directory documentation provides a reference for the plaintext configuration machinery in DiaB. Finally, you can read the Quickstart document to get started straight away.

For helpful information on site administration, consult the README which comes with every DiaB site.

Platforms

Django-in-a-Box currently only runs on UNIX-based systems. That means Mac OS X, *BSD, GNU/Linux and a few others. Unfortunately, I have neither the time, the resources nor the inclination to work around the issues which Windows presents; if you want to fork the project and add support yourself, go ahead.

Version Control

Django-in-a-Box was built to work well with Version Control Systems. There are just a couple of things to remember:

  • The project directory should be under version control, but not the site directory. The contents of the site directory will vary wildly from deployment to deployment, but the project directory should remain constant.

  • You'll want to tell your VCS to ignore certain types of file: compiled .pyc files, .DS_Store files, and the etc/ symlink in the project directory. On Mercurial, this is done with a .hgignore file; Git uses a .gitignore, and Subversion uses svn:ignore.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.