djangoproject.com source code
To run locally, do the usual:
Create a virtualenv
Install dependencies:
pip install -r requirements/dev.txt
Alternatively use the make task:
make install
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": ["any@email.com", "some_string"] }
Add export DJANGOPROJECT_DATA_DIR=~/.djangoproject (without the backticks) to your ~/.bashrc file and then run source ~/.bashrc to load the changes.
Create databases:
createuser -d djangoproject createdb -O djangoproject djangoproject createuser -d code.djangoproject createdb -O code.djangoproject code.djangoproject
Create tables:
psql -d code.djangoproject < tracdb/trac.sql ./manage.py migrate
Create a superuser:
./manage.py createsuperuser
Populate the www and docs hostnames in the django.contrib.sites app:
./manage.py loaddata dev_sites
For docs:
./manage.py loaddata doc_releases ./manage.py update_docs
For dashboard:
./manage.py loaddata dashboard_example_data ./manage.py update_metrics
Point the
www.djangoproject.dev
,docs.djangoproject.dev
anddashboard.djangoproject.dev
hostnames with your/etc/hosts
file tolocalhost
/127.0.0.1
. Here's how it could look like:127.0.0.1 docs.djangoproject.dev www.djangoproject.dev dashboard.djangoproject.dev
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.
Compile the CSS (only the source SCSS files are stored in the repostiory):
make compile-scss
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 http://www.djangoproject.dev:8000/, http://docs.djangoproject.dev:8000/ or http://dashboard.djangoproject.dev:8000/.
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:
https://travis-ci.org/django/djangoproject.com
For local development don't hesitate to install tox to run the website's test suite.
Then in the root directory (next to the manage.py
file) run:
tox
Behind the scenes this will run the usual ./manage.py 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:
./manage.py 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.
Styles
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:
- the site (similar to www.djangoproject.com) on http://0.0.0.0:8000/ to be used with the modified /etc/hosts file (see above)
- the
make
task to automatically compile the SASS files to CSS files
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 for managing JS library dependencies. See its documentation for how to use it. Here's the gist:
To update any of the dependencies, edit the bower.json
file accordingly
and then run bower install
to download the appropriate files to the
static directory. Commit the downloaded files to git (vendoring).
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 ./manage.py 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:
./manage.py 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.