Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.13 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.13 KB

Texas Advanced Computing Center

Django App: "The Example"

This app [provides something].

  • __dist-name__: django-tacc-the-example
  • __package_name__: django_tacc_the_example
  • __ClassName__: TheExample
  • "App Name": "The Example"

Important

After using this repository template for your app:

  1. Follow (wiki) Development Quick Start.
  2. Remove this notice.

Quick Start

  1. Follow (wiki) Usage Quick Start.

Important

After using this repository template for your app:

  1. Choose or replace all the step 2's with step(s) specific to your app.
  2. Remove this notice.

For a website using TACC/Core-CMS:

  1. Follow https://github.com/TACC/Core-CMS/blob/main/README.md.

For a Django CMS plugin:

  1. Any step that is specific to the app, such as the steps after this.

    # provide minimal example code that may help the reader
  2. Add a URLconf in your Django project's urls.py like this:

        url(r'^sysmon/', include('__package_name__.urls')),
  3. Add __APP_NAME_SOME_PROP__ property and value to your Django project's settings:

    __APP_NAME_SOME_PROP__ = 'specific_value'
  4. Visit http://your.project.url.host/some-app-url-path/.

Usage

Important

After using this repository template for your app:

  1. Replace the steps below with step(s) specific to your app.
  2. Remove this notice.

For a website using TACC/Core-CMS:

  1. Configure the website.
  2. Run the server and load the website.
  3. See server run without error and website matches configuration.

For a Django CMS plugin:

  1. Add instance of plugin to a page.
  2. Configure the plugin instance.
  3. See plugin render content that matches configuration.

Features

Important

After using this repository template for your app:

  1. Describe the feature(s) of the app, or remove this section.
  2. Remove this notice.