Usage Quick Start

This page describes how to use a DjangoCMS app.

• applicable to any Django project
• originally intended for https://github.com/TACC/Core-CMS (large proprietary project)
• testable via https://github.com/wesleyboar/django-cms-quickstart (small community project)

Note The __package_name__ and __Repo_Name__ come from the repository of the app being installed.

Add Dependency, Install, Migrate

1. Add the app in your Django project's dependency list e.g., requirements.txt, pyproject.toml.

   (use appropriate commit as needed)

   ... -e https://github.com/TACC/Core-CMS-__Repo_Name__.git@870ad79#egg=__package_name__
   

2. Add __package_name__ to your INSTALLED_APPS setting:

   INSTALLED_APPS = [
       ...
       '__package_name__',
   ]
   

3. Run python manage.py migrate __package_name__ to create the app models.*

^{* Not all applications have migrations. If the one you install has none, an error will say so.}

App-Specific Steps

Some apps may require one or more extra steps, which would be part of their repository Readme file.

4. (Examples)

• Add a URLconf in your Django project's urls.py like this:

      url(r'^url/', include('__package_name__.urls')),
  

• Add a specific property and value to your Django project's settings:

  __APP_NAME_SOME_PROP__ = 'specific_value'
  

Test the App

5. Visit http://your.project.url.host/ and test the app.

The app repository Readme file should describe how to test or use the app.