armstrong 11.06.0.beta.1

Development Releases

You can track the latest development of Armstrong by installing the development version from Git. Obtain the latest version by visiting our GitHub page and either cloning or downloading a tarball.

Once obtained, switch into the directory of the repository (or snapshot if a tarball was downloaded) and tell pip to install it:

$ git clone git://github.com/armstrongcms/armstrong.git
... a few lines of output from Git ...
$ pip install .

Armstrong Project Structure

The following files are created in the mysite directory:

|~config/
| |-defaults.py
| |-development.py
| |-__init__.py
| |-production.py
| `-urls.py
|~requirements/
| |-development.txt
| `-project.txt
|~templates/
| `-index.html
|-wsgi.py

The config directory contains your settings and root URLConf for Django. The config.defaults module contains all of the base settings that are common to your environment. config.development has settings specific to your development environment, while config.production contains all of your production settings. config.urls is configured as the root URL configuration for your project.

You need to edit the config.development and config.production to configure the database engine you want to use.

All of your requirements are specified inside the two text files in the requirements directory: development.txt and project.txt. You can use pip to install the dependencies of your project by providing either file as an argument to pip install -r. development.txt should contain all of requirements for your development environment and include project.txt. The project.txt file should contain all of requirements that you have to have for your project.

The templates directory is configured as the base for your project’s templates. It contains a simple index.html that is loaded on a request to / so you can verify that everything is setup correctly.

The wsgi.py provides a basic WSGI module for running your project. It is configured to run using the config.development settings, so you must adjust it prior to running in production.

Note: You do not have to use the Armstrong project layout. You can utilize all of Armstrong’s components inside an existing Django project. These are here simply to help get you started.

Next Steps

Once you have the project created and configured (remember, you need to setup your database just like any other Django project), you’ve got one final step. You need to install the requirements file as there are packages that Armstrong relies on that need to be installed from GitHub.

$ cd mysite
$ pip install -r requirements/project.txt

Once pip has finished, you can test out everything by running armstrong runserver from inside your project. When you load the server, you should see the welcome page.

Congrats, you’re now setup and ready to start developing on Armstrong.