https://github.com/tacc/django-app
A Django app _to_or_for______.
https://github.com/tacc/django-app
django django-cms django-cms-plugin tacc website
Last synced: about 2 months ago
JSON representation
A Django app _to_or_for______.
- Host: GitHub
- URL: https://github.com/tacc/django-app
- Owner: TACC
- License: bsd-2-clause
- Created: 2021-10-06T22:04:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T18:54:47.000Z (4 months ago)
- Last Synced: 2025-01-27T19:51:51.258Z (4 months ago)
- Topics: django, django-cms, django-cms-plugin, tacc, website
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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](https://github.com/TACC/Django-App/wiki/Development-Quick-Start).
> 2. Remove this notice.
## Quick Start
1. Follow [(wiki) Usage Quick Start](https://github.com/TACC/Django-App/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**:
2. Follow https://github.com/TACC/Core-CMS/blob/main/README.md.
For a **Django CMS** plugin:
2. Any step that is specific to the app, such as the steps after this.
```python
# provide minimal example code that may help the reader
```
3. Add a URLconf in your Django project's `urls.py` like this:
```python
url(r'^sysmon/', include('__package_name__.urls')),
```
4. Add `__APP_NAME_SOME_PROP__` property and value to your Django project's settings:
```python
__APP_NAME_SOME_PROP__ = 'specific_value'
```
5. Visit [http://your.project.url.host/some-app-url-path/](http://127.0.0.1:8000/ "The URL for your environment may be different than this.").
## 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.
1. Run the server and load the website.
1. See server run without error and website matches configuration.
For a **Django CMS** plugin:
1. Add instance of plugin to a page.
1. Configure the plugin instance.
1. 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.
…