Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
F/E documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Greg Turner committed Nov 13, 2016
1 parent 61cba06 commit a273515
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/howto/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ All settings are optional, but you can provide:

## Where to put files

Put your layout template files in `templates/layouts/`.

Put your static files (js/css/static images) in `static/`.

Anything you put in the `static` or `templates` directories will override the
default ICEkit static files and templates.

Expand All @@ -56,6 +60,27 @@ The `project_settings.py` file is a Django settings module. You can override any
default Django/ICEkit settings or configure apps installed via `requirements
.txt`.


## How do I add project-specific URLs?

Create a `urls.py` file in a project folder of your choice, such as `myproject`.
It can contain something like


from django.conf.urls import include, patterns, url

urlpatterns = patterns(
'myproject.views',
... your URLs here ...
# finally, fall back to ICEkit/GLAMkit URLs.
url('', include('icekit.project.urls')), # use `glamkit_urls` if this is a GLAMkit project
]

Lastly, in `project_settings.py`, override the default URL path:

ROOT_URLCONF = 'myproject.urls'


## Where's my virtualenv? How do I modify a source package?

If you're running in Docker, the requirements are installed in the Docker image
Expand Down

0 comments on commit a273515

Please sign in to comment.