Skip to content
Source code to
JavaScript Python HTML CSS CoffeeScript Ruby Other
Find file
Failed to load latest commit information.
accounts Added on_delete to ForeignKey and OneToOneField.
aggregator Removed flake8 exclude from migrations.
blog Removed flake8 exclude from migrations.
contact Added email validation to contact form.
dashboard Removed flake8 exclude from migrations.
djangoproject Removed unused fundraising JavaScript/CSS.
docs Removed flake8 exclude from migrations.
fundraising Removed flake8 exclude from migrations.
legacy Removed usage of deprecated SimpleTestCase.urls.
members Fixed #628 -- Made corporate membership logo required.
releases Removed flake8 exclude from migrations.
requirements Updated to elasticsearch-dsl==0.0.11 and elasticsearch==2.2.0
svntogit Removed usage of deprecated assertEquals().
tracdb Added on_delete to ForeignKey and OneToOneField.
.bowerrc Added bower config and use local webfont loader.
.coveragerc Fixed tests and added CI.
.editorconfig Add EditorConfig file
.gitignore Improved Bower integration.
.travis.yml Add isort settings and sort imports
LICENSE Fixed #477 -- Added LICENSE.
Makefile Removed cla app in a few more places.
Procfile Big refactor that combines www and docs.
README.rst Improved Bower integration.
bower.json Improved Bower integration. Big refactor that combines www and docs.
package.json Improved Bower integration.
setup.cfg Removed flake8 exclude from migrations.
tox.ini Add isort settings and sort imports

README.rst source code

To run locally, do the usual:

  1. Create a virtualenv

  2. Install dependencies:

    pip install -r requirements/dev.txt
    npm install

    Alternatively use the make task:

    make install
  3. Make a directory to store the project's data (MEDIA_ROOT, DOC_BUILDS_ROOT, etc.). We'll use ~/.djangoproject for example purposes.

    Create a 'secrets.json' file in a folder named 'conf' in that directory, containing something like:

    { "secret_key": "xyz",
      "superfeedr_creds": ["", "some_string"] }

    Add export DJANGOPROJECT_DATA_DIR=~/.djangoproject (without the backticks) to your ~/.bashrc file and then run source ~/.bashrc to load the changes.

  4. Create databases:

    createuser -d djangoproject
    createdb -O djangoproject djangoproject
    createuser -d code.djangoproject
    createdb -O code.djangoproject code.djangoproject
  5. Create tables:

    psql -d code.djangoproject < tracdb/trac.sql
    ./ migrate
  6. Create a superuser:

    ./ createsuperuser
  7. Populate the www and docs hostnames in the django.contrib.sites app:

    ./ loaddata dev_sites
  8. For docs:

    ./ loaddata doc_releases
    ./ update_docs
  9. For dashboard:

    ./ loaddata dashboard_example_data
    ./ update_metrics
  10. Point the, and hostnames with your /etc/hosts file to localhost/ Here's how it could look like:

    If you're on Mac OS and don't feel like editing the /etc/hosts file manually, there is a great preference pane called Hosts.prefpane. On Ubuntu there is a built-in network admin GUI to do the same. Remember both require admin privileges, just like you'd need when editing /etc/hosts with your favorite editor.

  1. Compile the CSS (only the source SCSS files are stored in the repostiory):

    make compile-scss
  2. Finally run the server:

    make run

    This runs both the main site ("www") as well as the docs and dashboard site in the same process. Open, or

Running the tests

We use Travis-CI for continuous testing and GitHub pull request integration. If you're familiar with those systems you should not have any problems writing tests.

Our test results can be found here:

For local development don't hesitate to install tox to run the website's test suite.

Then in the root directory (next to the file) run:


Behind the scenes this will run the usual ./ test management command with a preset list of apps that we want to test as well as flake8 for code quality checks. We collect test coverage data as part of that tox run, to show the result simply run:

coverage report

or for a HTML-based report:

coverage html

(Optional) In case you're using an own virtualenv you can also run the tests manually using the test task of the Makefile. Don't forget to install the test requirements with the following command first though:

pip install -r requirements/tests.txt

Then run:

make test

or simply the usual test management command:

./ test [list of app labels]

Supported browsers

The goal of the site is to target various levels of browsers, depending on their ability to use the technologies in use on the site, such as HTML5, CSS3, SVG, webfonts.

We're following Mozilla's example when it comes to categorize browser support.

  • Any browser other than IE8 and lower as A grade. Which means everything needs to work on those.
  • IE8 is B grade, meaning that some functionality may be disabled, visual variations are acceptable but the content must work nevertheless.
  • IE below 8 is not supported.
  • Mobile browsers should be considered B grade as well. Mobile Safari, Firefox on Android and the Android Browser should support the responsive styles as much as possible but some degredation can't be prevented due to the limited screen size and other platform restrictions.

File locations

Static files such as CSS, JavaScript or image files can be found in the djangoproject/static subdirectory.

Templates can be found in the djangoproject/templates subdirectory.


CSS is written in Scss and compiled via Libsass.

Run the following to compile the Scss files to CSS:

make compile-scss-debug

Alternatively you can also run the following command in a separate shell to continuously watch for changes to the Scss files and automatically compile to CSS:

make watch-scss

Running all at once

Optionally you can use a tool like Foreman to run all process at once:

This is great during development. Assuming you're using Foreman simply run:

foreman start

If you just want to run one of the processes defined above use the run subcommand like so:

foreman run web

That'll just run the www server.

Check out the Procfile file for all the process names.

JavaScript libraries

This project uses Bower to manage JavaScript libraries.

At any time, you can run it to install a new library (e.g., jquery-ui):

npm run bower install jquery-ui --save

or check if there are newer versions of the libraries that we use:

npm run bower ls

If you need to update an existing library, the easiest way is to change the version requirement in bower.json and then to run npm run bower install again.

We commit the libraries to the repository, so if you add, update, or remove a library from bower.json, you will need to commit the changes in djangoproject/static too.

Documentation search

In case you want to use the documentation search you have to install Elasticsearch locally and start it on port 9200 (the default). See the official Elasticsearch docs for how to set it up.

When running ./ update_docs to build all documents it will also automatically index every document it builds in the search engine as well. In case you've already built the documents and would like to reindex the search index run the command:

./ update_index

This is also the right command to run when you work on the search feature itself. You can pass the -d option to try to drop the search index first before indexing all the documents.

Something went wrong with that request. Please try again.