From 009c73ccdfcd5e1a4f6e7a736fa181df700f165b Mon Sep 17 00:00:00 2001 From: Jun-te Kim Date: Tue, 19 May 2026 12:21:25 +0000 Subject: [PATCH] parent folder structure --- applications/README.md | 1 + deployment/README.md | 1 + domain/README.md | 3 +++ infrastructure/README.md | 8 ++++++++ orchestration/README.md | 1 + tests/README.md | 1 + utilities/README.md | 1 + utils/README.md | 1 + 8 files changed, 17 insertions(+) create mode 100644 applications/README.md create mode 100644 deployment/README.md create mode 100644 domain/README.md create mode 100644 infrastructure/README.md create mode 100644 orchestration/README.md create mode 100644 tests/README.md create mode 100644 utilities/README.md create mode 100644 utils/README.md diff --git a/applications/README.md b/applications/README.md new file mode 100644 index 00000000..6cb752e1 --- /dev/null +++ b/applications/README.md @@ -0,0 +1 @@ +The applications that run Ara. These should fundamentally call things from orchestration and should just be the entry point for things that need to be deployed. \ No newline at end of file diff --git a/deployment/README.md b/deployment/README.md new file mode 100644 index 00000000..e544cb14 --- /dev/null +++ b/deployment/README.md @@ -0,0 +1 @@ +Deploy applications within our AWS \ No newline at end of file diff --git a/domain/README.md b/domain/README.md new file mode 100644 index 00000000..e2551a5f --- /dev/null +++ b/domain/README.md @@ -0,0 +1,3 @@ +Domna specific domains defined as classes + +Files here should consists in business logic and definition \ No newline at end of file diff --git a/infrastructure/README.md b/infrastructure/README.md new file mode 100644 index 00000000..f31037d8 --- /dev/null +++ b/infrastructure/README.md @@ -0,0 +1,8 @@ +Infrastructure + +APIs, ETL, data fetching, scraping. + +This parents directory is defined for things that we use to make our repositories as well allow us to save, load and view data from our repositories. + + +This allows repositories to have a common interface without knowing how to individuall access each conneciton diff --git a/orchestration/README.md b/orchestration/README.md new file mode 100644 index 00000000..2b494968 --- /dev/null +++ b/orchestration/README.md @@ -0,0 +1 @@ +Orchestration \ No newline at end of file diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 00000000..d6ea62a0 --- /dev/null +++ b/tests/README.md @@ -0,0 +1 @@ +Where our tests will live \ No newline at end of file diff --git a/utilities/README.md b/utilities/README.md new file mode 100644 index 00000000..276ef091 --- /dev/null +++ b/utilities/README.md @@ -0,0 +1 @@ +Helper functions/class that help acorss multiple domains, infrastructure, applications, orchestration, repostitories \ No newline at end of file diff --git a/utils/README.md b/utils/README.md new file mode 100644 index 00000000..de43c7a2 --- /dev/null +++ b/utils/README.md @@ -0,0 +1 @@ +This library is going to be retired with utilities \ No newline at end of file