This is an automated email from the ASF dual-hosted git repository.

machristie pushed a commit to branch main
in repository 
https://gitbox.apache.org/repos/asf/airavata-cookiecutter-django-app.git

commit 4e8f6084380345790aef286aea24eed1206b2592
Author: Marcus Christie <[email protected]>
AuthorDate: Wed Jul 7 14:50:45 2021 -0400

    Add documentation on how to configure settings in AppConfig class
---
 .../{{cookiecutter.project_slug}}/apps.py             | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git 
a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/apps.py 
b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/apps.py
index 0055edc..b8af0d7 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/apps.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/apps.py
@@ -2,6 +2,25 @@ from django.apps import AppConfig
 
 
 class {{ cookiecutter.app_config_class_name }}(AppConfig):
+    # Standard Django app configuration. For more information on these 
settings,
+    # see 
https://docs.djangoproject.com/en/2.2/ref/applications/#application-configuration
     name = '{{ cookiecutter.project_slug }}'
     label = name
     verbose_name = "{{ cookiecutter.project_name }}"
+
+    # The following are Airavata Django Portal specific custom Django app 
settings
+
+    # Set url_home to a namespaced URL that will be the homepage when the 
custom
+    # app is selected from the main menu
+    url_home = "{{ cookiecutter.project_slug }}:home"
+
+    # Set fa_icon_class to a FontAwesome CSS class for an icon to associate 
with
+    # the custom app. Find an icon class at 
https://fontawesome.com/icons?d=gallery&p=2&s=regular,solid&m=free
+    fa_icon_class = "fa-circle"
+
+    # Second level navigation. Defines sub-navigation that displays on the left
+    # hand side navigation bar in the Django Portal. This is optional but
+    # recommended if your custom Django app has multiple entry points. See the
+    # description of *nav* in
+    # 
https://apache-airavata-django-portal.readthedocs.io/en/latest/dev/new_django_app/#appconfig-settings
+    # for more details for more details.

Reply via email to