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 @@ + + +
๐Ÿ—๏ธ Setup
Load templates and plugins
Load metadata
๐Ÿ—๏ธ Setup...
๐Ÿ“ฎ Serve requests
Waiting for web requests
๐Ÿ“ฎ Serve requests...
๐Ÿ“• Clone community templates
๐Ÿ“• Clone community templates
๐Ÿ”ง Load settings.json
๐Ÿ”ง Load settings.json
โš’๏ธ Action setup
Pull or rebuild docker image
Load user inputs and setup
โš’๏ธ Action setup...
๐Ÿ› ๏ธ Web setup
Setup server and middlewares
๐Ÿ› ๏ธ Web setup...
๐ŸŽจ Pre-rendering
Parse user inputsย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย 
๐ŸŽจ Pre-rendering...
๐Ÿ–Œ๏ธ Post-rendering
Apply config parameters
Resizing with puppeteer
๐Ÿ–Œ๏ธ Post-rendering...
๐Ÿ—ƒ๏ธ Base plugin
Base GitHub data is fetched
๐Ÿ—ƒ๏ธ Base plugin...
๐Ÿงฉ Metrics plugins
Enabled plugins are executed
๐Ÿงฉ Metrics plugins...
๐Ÿ–ผ๏ธ Template entry
Handles core plugin execution
Format data specific to template
๐Ÿ–ผ๏ธ Template entry...
๐Ÿ–ผ๏ธ Template entry
Handles core plugin execution
Format data specific to template
๐Ÿ–ผ๏ธ Template entry...
๐Ÿงฑ Core plugin
Handles other plugin execution
Format base plugin data
๐Ÿงฑ Core plugin...
๐Ÿ–จ๏ธ Partials rendering
Template partials rendering with
computed 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 rendering
Viewer 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: - +![Architecture](/.github/architecture.svg)