From 1644d9ca9344754e4f79c0ad1de1ac602bb3ff85 Mon Sep 17 00:00:00 2001 From: Varun Singh Date: Fri, 15 Dec 2023 11:45:15 -0800 Subject: [PATCH 1/5] updated architecture diagram --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b9a5418..3ef9fc8 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,28 @@ This repository is a Feed Amalgamator for various Fediverse platforms, in order ```mermaid graph TD - subgraph Fetchers - LF[LemmyFetcher] -->|Fetches posts| LPB[LemmyPostBuilder] - MF[MastodonFetcher] -->|Fetches posts| MPB[MastodonPostBuilder] - OF[Other Fetchers] -->|Fetches posts| OPB[Other PostBuilders] + subgraph Instances + L1[LemmyInstance1] -->|API Response| LF[LemmyFetcher] + L2[LemmyInstance2] -->|API Response| LF + L3[LemmyInstance3] -->|API Response| LF + + M1[LemmyInstance1] -->|API Response| MF[MastodonFetcher] + M2[LemmyInstance2] -->|API Response| MF + M3[LemmyInstance3] -->|API Response| MF + + O1[OtherInstances] -->|API Response| OF[Other Fetchers] end - subgraph PostBuilders - LPB -->|Builds post elements| PF[PostFactory] - MPB -->|Builds post elements| PF - OPB -->|Builds post elements| PF + subgraph Fetchers + LF -->|Fetched posts| LPB[LemmyPostBuilder] + MF -->|Fetched posts| MPB[MastodonPostBuilder] + OF -->|Fetched posts| OPB[Other PostBuilders] end - subgraph Factory - PF -->|Creates fetchers and post builders| P[Paginator] + subgraph PostBuilders + LPB -->|Builds post elements| P[Paginator] + MPB -->|Builds post elements| P + OPB -->|Builds post elements| P end subgraph Paginator @@ -40,7 +48,7 @@ graph TD end subgraph Application Initialization - IJS -->|Initializes application| ST[styles/index.css] + IJS -->|Initializes application| ST[index.html] end style Fetchers fill:#f9f,stroke:#333,stroke-width:2px From c01788e6d746617d2bec622c4c2864fb40bd176b Mon Sep 17 00:00:00 2001 From: Varun Singh Date: Fri, 15 Dec 2023 11:47:18 -0800 Subject: [PATCH 2/5] fixes to architecture diagram, removed unused styles --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3ef9fc8..c5674af 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,14 @@ graph TD P -->|Manages pagination| IJS[index.js] end - subgraph Application Initialization + subgraph Application IJS -->|Initializes application| ST[index.html] end - style Fetchers fill:#f9f,stroke:#333,stroke-width:2px + style Fetchers fill:#cfc,stroke:#333,stroke-width:2px style PostBuilders fill:#ccf,stroke:#333,stroke-width:2px - style Factory fill:#cfc,stroke:#333,stroke-width:2px style Paginator fill:#fcf,stroke:#333,stroke-width:2px - style Application Initialization fill:#cff,stroke:#333,stroke-width:2px + style Application fill:#cff,stroke:#333,stroke-width:2px ``` # Repository Structure From 4b4991f8bfd95cec4a7230b5b50a99d0f1b4643d Mon Sep 17 00:00:00 2001 From: Varun Singh Date: Fri, 15 Dec 2023 11:48:04 -0800 Subject: [PATCH 3/5] made diagram readable, removed colors --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index c5674af..2bc1956 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,6 @@ graph TD subgraph Application IJS -->|Initializes application| ST[index.html] end - - style Fetchers fill:#cfc,stroke:#333,stroke-width:2px - style PostBuilders fill:#ccf,stroke:#333,stroke-width:2px - style Paginator fill:#fcf,stroke:#333,stroke-width:2px - style Application fill:#cff,stroke:#333,stroke-width:2px ``` # Repository Structure From cd87e7e000eedda4d30e3c268671bc2a2121f723 Mon Sep 17 00:00:00 2001 From: Jackson Conte Date: Fri, 15 Dec 2023 11:53:01 -0800 Subject: [PATCH 4/5] Update branching strategy.md --- admin/ADRs/branching strategy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/admin/ADRs/branching strategy.md b/admin/ADRs/branching strategy.md index 663bf50..298480b 100644 --- a/admin/ADRs/branching strategy.md +++ b/admin/ADRs/branching strategy.md @@ -20,8 +20,8 @@ We did not end up originally deciding on a branching style early in the project, but our working style within the team lended itself to the feature branching strategy. We tended to work on particular features in bursts of work, not consistently each day, which lead us to make branches for each feature. We decided to formalize this strategy after our second sprint retrospective. ## Links/References -[Second sprint retrospective](../meetings/2023-12-4.md#sprint-retrospective) +[Second sprint retrospective](../meetings/2023-12-04.md#sprint-retrospective) ​ ## Date: 2023-12-04 The date the decision was made. -(ISO 8601 date format) \ No newline at end of file +(ISO 8601 date format) From f2742b90f5cf7a369e3949cdfddeb88fb33b6ef9 Mon Sep 17 00:00:00 2001 From: Varun Singh Date: Fri, 15 Dec 2023 12:01:19 -0800 Subject: [PATCH 5/5] updated dates for ADRs --- admin/ADRs/code linting.md | 3 ++- admin/ADRs/custom elements for posts.md | 3 ++- admin/ADRs/project deployment.md | 3 ++- admin/ADRs/testing framework.md | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/admin/ADRs/code linting.md b/admin/ADRs/code linting.md index b6cb9b2..3c7bffd 100644 --- a/admin/ADRs/code linting.md +++ b/admin/ADRs/code linting.md @@ -21,7 +21,8 @@ We have decided to adopt ESLint as our primary tool for linting our JavaScript c ## Links/References - [ESLint Official Website](https://eslint.org/) - [ESLint Configuration Guide](https://eslint.org/docs/user-guide/configuring) +- [Meeting Notes November 18](admin/meetings/2023-11-18.md) -## Date: YYYY-MM-DD +## Date: 2023-11-18 The date the decision was made. (ISO 8601 date format) diff --git a/admin/ADRs/custom elements for posts.md b/admin/ADRs/custom elements for posts.md index 4a5e34a..b45fafe 100644 --- a/admin/ADRs/custom elements for posts.md +++ b/admin/ADRs/custom elements for posts.md @@ -20,7 +20,8 @@ Decided to implement custom elements for posts within our web application. Custo ## Links/References - [Web Components Introduction](https://developer.mozilla.org/en-US/docs/Web/Web_Components) - [Using Custom Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) +- [Meeting Notes for Nov 29](admin/meetings/2023-11-29.md) -## Date: YYYY-MM-DD +## Date: 2023-11-29 The date the decision was made. (ISO 8601 date format) diff --git a/admin/ADRs/project deployment.md b/admin/ADRs/project deployment.md index 9b2ea19..3e86451 100644 --- a/admin/ADRs/project deployment.md +++ b/admin/ADRs/project deployment.md @@ -20,8 +20,9 @@ Decided to use Netlify as our deployment platform for the main project. ## Links/References - [Netlify Documentation](https://docs.netlify.com) - [Netlify Pricing](https://www.netlify.com/pricing/) +- [Meeting Notes for November 29](admin/meetings/2023-11-29.md) -## Date: YYYY-MM-DD +## Date: 2023-11-29 The date the decision was made. (ISO 8601 date format) diff --git a/admin/ADRs/testing framework.md b/admin/ADRs/testing framework.md index 12214fe..1b8d652 100644 --- a/admin/ADRs/testing framework.md +++ b/admin/ADRs/testing framework.md @@ -18,6 +18,6 @@ Team decided to adopt Node.js native testing tools, for implementing our unit te ## Links/References - Node.js `assert` module documentation: [https://nodejs.org/api/assert.html](https://nodejs.org/api/assert.html) -## Date: YYYY-MM-DD +## Date: 2023-11-11 The date the decision was made. (ISO 8601 date format)