From a77a18967c5bee6c33f040e94e95da1c5042dcf9 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Sun, 11 Apr 2021 09:48:44 +0200 Subject: [PATCH] Update ARCHITECTURE.md --- .github/architecture.svg | 3 +++ ARCHITECTURE.md | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .github/architecture.svg diff --git a/.github/architecture.svg b/.github/architecture.svg new file mode 100644 index 00000000..ab63da6a --- /dev/null +++ b/.github/architecture.svg @@ -0,0 +1,3 @@ + + +๐๏ธ SetupLoad templates and pluginsLoad metadata๐๏ธ Setup...๐ฎ Serve requestsWaiting for web requests๐ฎ Serve requests...๐ Clone community templates๐ Clone community templates๐ง Load settings.json๐ง Load settings.json โ๏ธ Action setupPull or rebuild docker imageLoad user inputs and setupโ๏ธ Action setup...๐ ๏ธ Web setupSetup server and middlewares๐ ๏ธ Web setup...๐จ Pre-renderingParse user inputsย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ๐จ Pre-rendering...๐๏ธ Post-renderingApply config parametersResizing with puppeteer๐๏ธ Post-rendering...๐๏ธ Base pluginBase GitHub data is fetched ๐๏ธ Base plugin...๐งฉ Metrics pluginsEnabled plugins are executed๐งฉ Metrics plugins...๐ผ๏ธ Template entryHandles core plugin executionFormat data specific to template๐ผ๏ธ Template entry...๐ผ๏ธ Template entryHandles core plugin executionFormat data specific to template๐ผ๏ธ Template entry...๐งฑ Core pluginHandles other plugin executionFormat base plugin data๐งฑ Core plugin...๐จ๏ธ Partials renderingTemplate partials rendering withcomputed data๐จ๏ธ Partials rendering...๐ Serve rendering to client๐ Serve rendering to client๐ Publish rendering to GitHub๐ Publish rendering to GitHub๐ Web server๐ Web server โ๏ธ GitHub Actionโ๏ธ GitHub Action๐ค Common๐ค Common ๐ Common rendering๐ Common renderingViewer does not support full SVG 1.1 \ No newline at end of file diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 732fdc45..eee72092 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -1,5 +1,5 @@ -# ๐ Architecture +# ๐ Project architecture Following diagram explain how **metrics** code is structured: - +