Settings

Core Settings

Here’s a list of settings available in Grit One SDK and their default values.

In app/settings.py:

from grit.core.types import CoreSettingsTypedDict

CORE_SETTINGS: CoreSettingsTypedDict = {
    # Domain settings
    'SUBDOMAIN_NAME': 'dev',
    'DOMAIN_NAME': "meetgrit.com",
    # ...
}

Domain Settings

DOMAIN_NAME

Default: 'localhost'

The custom domain name where your app will live.

SUBDOMAIN_NAME

Default: 'www'

Subdomain name.

PLATFORM_NAME

Default: 'platform'

The subdomain used for the platform redirect URL. When combined with your DOMAIN_NAME, this creates the platform access URL. For example, if DOMAIN_NAME is "example.com" and PLATFORM_NAME is "platform", the resulting URL will be https://platform.example.com

TIME_ZONE

Default: 'UTC'

The time zone for the application.

Deployment Settings - AWS

AWS_RDS_ENDPOINT

Default: ''

Your AWS RDS Endpoint for deployment.

AWS_PROFILE

Default: ''

Your AWS Profile for deployment.

AWS_ACCOUNT_ID

Default: ''

Your AWS Account ID for deployment.

AWS_REGION

Default: 'us-east-1'

Your AWS Region for deployment.

IMAGE_NAME

Default: ''

The Docker image name used for deployment.

ECR_REPOSITORY_NAME

Default: ''

The AWS ECR repository name for storing Docker images.

Deployment Settings - Azure

AZURE_ACR_REGISTRY_NAME

Default: ''

The Azure Container Registry name.

AZURE_ACR_REPOSITORY_NAME

Default: ''

The Azure Container Registry repository name.

App Settings

ADDITIONAL_INSTALLED_APPS

Default: []

A list of additional apps to install. Use this to register your project-specific apps and any extra Grit SDK apps.

'ADDITIONAL_INSTALLED_APPS': [
    'app.auth.apps.AuthConfig',
    'grit.payments.apps.PaymentsConfig',
    'app.payments',
    # ...
]

Authentication Settings

AUTH_SETTINGS

LOGIN_VIEW

In app/settings.py:

from grit.auth.types import AuthSettingsTypedDict

AUTH_SETTINGS: AuthSettingsTypedDict = {
    'LOGIN_VIEW': 'app.auth.views.custom_login_view',
    'EMAIL_VERIFICATION': 'mandatory',
    'EMAIL_VERIFICATION_RESEND_COOLDOWN_SECONDS': 30
}

In app/auth/views.py:

from grit.auth.forms import EmailAuthenticationForm


class CustomLoginView(auth_views.LoginView):
    template_name = 'app/auth/login.html'
    form_class = EmailAuthenticationForm


def custom_login_view(request):
    return CustomLoginView.as_view()(request)