Repository

Description of the Automail folder structure.

All instance-specific configurations must be made in the project folder.

Don't make any changes outside the project folder as these will be overwritten in the subsequent sync with the main Automail repository.

Each Automail fork has the following folders:

  • deployment

    • container

      • docker

      • terraform

    • iis

  • software

    • configurations default settings

    • polygon generic modules (Python, JavaScript, HTML, and CSS)

    • project the instance-specific folder

      • custom_web UI configuration

        • admin.py

        • apps.py

        • functions.py

        • global_variables.py

        • model_choices.py

        • models.py

        • url_variables.py

        • urls.py

        • views.py

      • automail.py script to launch the local test server, create and migrate models

      • static instance-specific static files that will be publicly available and served to the frontend

      • tests instance-specific tests

    • utilities utility functions

      • algorithm_utils.py

      • api_utils_aws.py

      • api_utils_google.py

      • api_utils_microsoft.py

      • api_utils_sendgrid.py

      • api_utils.py

      • class_utils.py

      • datatype_utils.py

      • datetime_utils.py

      • os_utils.py

      • pandas_utils.py

      • range_utils.py

      • str_utils.py

Last updated