From dccf4daa191a6205c654120319c04467d7534549 Mon Sep 17 00:00:00 2001 From: Rishi Ghan Date: Wed, 13 Oct 2021 08:18:06 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=A7=20Added=20architecture=20doc=20and?= =?UTF-8?q?=20some=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/architecture.md | 33 +++++++++++++++++++++++++++++++++ docusaurus.config.js | 18 +++++++----------- 2 files changed, 40 insertions(+), 11 deletions(-) create mode 100644 docs/architecture.md diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..a46615a --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 4 +id: architecture +title: Technical Architecture +--- + +### High-level Architecture + +`ThreeTwo!`, the app is built upon the microservice architecture. The UI is a standalone `node.js` app and the rest of the logic is broken into microservices. + +The microservices deal with: + +1. Library functions (model orchestration, CRUD ops on comics, metadata) +2. Comic Vine (scraping issues, volumes and more) +3. Grand Comics Database (scraping, aggregations and more) +4. Helpers (image transformation, file-system ops, compression/uncompression) + +### Technical stack + +`ThreeTwo!` is written in `TypeScript` from UI to the services layer. + +The technologies used are: + +1. React +2. Redux +3. moleculer +4. RabbitMQ +5. socket.io +6. node.js +7. Express +8. MongoDB +9. mongoose + diff --git a/docusaurus.config.js b/docusaurus.config.js index d9d86e6..a48ee84 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -53,7 +53,7 @@ const config = { type: 'doc', docId: 'intro', position: 'left', - label: 'Tutorial', + label: 'Quick Start', }, {to: '/blog', label: 'Blog', position: 'left'}, { @@ -79,16 +79,12 @@ const config = { title: 'Community', items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', + label: 'Github', + href: 'https://github.com/rishighan/threetwo', }, { label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', - }, - { - label: 'Twitter', - href: 'https://twitter.com/docusaurus', + href: 'https://discord.gg/DbpcSNuM', }, ], }, @@ -100,13 +96,13 @@ const config = { to: '/blog', }, { - label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + label: 'Rishi Ghan', + href: 'https://rishighan.com', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} Quasar Software, LLC. Built with Docusaurus.`, }, prism: { theme: lightCodeTheme,