Merge pull request #4 from rishighan/original-folder-state

Original folder state

.github/workflows/documentation.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Release to GitHub Pages
         env:
           USE_SSH: true
-          GIT_USER: git
+          GIT_USER: rishighan
         run: |
           git config --global user.email "rishi.ghan@gmail.com"
           git config --global user.name "rishighan"

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
+

docs/unraid_dockercompose.md

@@ -0,0 +1,203 @@
+---
+sidebar_position: 2 
+id: unRAID_dockercompose
+title: Install ThreeTwo! on unRAID with the docker-compose plugin
+---
+
+### Notes
+
+This guide goes over ThreeTwo! installation on unRAID using the [docker-compose manager](https://forums.unRAID.net/topic/114415-plugin-docker-compose-manager/) plugin. Currently, this is the recommended approach for unRAID users.
+
+With the help of this plugin, you are able to pull the entire ThreeTwo! `docker-compose` stack up, down with the click of a button. It abstracts away a lot of complexity associated with writing out commands in the console.
+
+That said, the plugin is still in beta, so you may experience strange behavior.  
+
+### Pre-requisites
+
+First things first, let's go over what the pre-requisites are:
+
+1. The `docker-compose` configuration for ThreeTwo! now resides in its own repo here: https://github.com/rishighan/threetwo-docker-compose You will be using this as reference.
+2. A working `AirDC++` install is necessary for `DC++` searching/downloading to work. You can install it through the unRAID via the CA store or via a [docker](https://airdcpp.net/download#linux-nas-docker-other)
+3. `comics` and `userdata` folders.
+   1. The `comics` folder _must_ be the folder `AirDC++` downloads comics to.
+   2. Create the `userdata` folder under `/mnt/user/appdata/threetwo`
+4. To get ComicVine to work for metadata scraping and other functions, you _must_ have a ComicVine API key. You can get one [here](https://comicvine.gamespot.com/api/). Metadata scraping will not work unless you supply an API key.
+5. Open an unRAID terminal and create an `.env` file:
+   1. Run this command: `nano /boot/config/plugins/compose.manager/projects/ThreeTwo/.env`
+   2. Paste this into the file, replacing anything within `<>` with actual values:
+   ```bash
+   UNDERLYING_HOSTNAME=<UNRAID_HOSTNAME>
+   COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY>
+   USERDATA_DIRECTORY=/mnt/user/appdata/threetwo/userdata
+
+   COMICVINE_API_KEY=<YOUR_COMICVINE_API_KEY>
+
+   LOGGER=true
+   LOGLEVEL=info
+   SERVICEDIR=dist/services
+
+   CHOKIDAR_USEPOLLING=true
+
+   UNRAR_BIN_PATH=/usr/bin/unrar
+   SEVENZ_BINARY_PATH=/usr/bin/7za
+   MONGO_URI=mongodb://db:27017/threetwo
+   ELASTICSEARCH_URI=http://elasticsearch:9200
+   REDIS_URI=redis://redis:6379
+   TRANSPORTER=redis://redis:6379
+   CACHER=Memory
+      ```
+
+### Installation
+
+1. Install the `docker-compose manager` plugin from the unRAID CA store. After installation, you can find the plugin UI under the `Docker` tab.
+2. Create a new stack, give it a name.
+3. Hover over the gear next to it and click on `Edit Stack`.
+4. Copy-paste this into the textarea:
+```yaml
+version: "3.7"
+
+x-userdata-volume: &userdata-volume
+  type: bind
+  source: ${USERDATA_DIRECTORY}
+  target: /userdata
+
+x-comics-volume: &comics-volume
+  type: bind
+  source: ${COMICS_DIRECTORY}
+  target: /comics
+
+services:
+threetwo:
+   build:
+      context: https://github.com/rishighan/threetwo.git
+      dockerfile: Dockerfile
+   image: frishi/threetwo
+   container_name: threetwo-ui
+   env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
+   restart: unless-stopped
+   ports:
+      - "8050:8050"
+      - "3050:3050"
+   links:
+      - core-services
+   depends_on:
+      - db
+      - elasticsearch
+      - redis
+   networks:
+      - proxy
+
+metadata-service:
+   build:
+      context: https://github.com/rishighan/threetwo-metadata-service.git
+   image: frishi/threetwo-metadata-service
+   container_name: metadata-service
+   ports:
+      - "3080:3080"
+   environment:
+      SERVICES: api,comicvine
+   env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
+   depends_on:
+      - redis
+   volumes:
+      - *comics-volume
+      - *userdata-volume
+   networks:
+      - proxy
+
+core-services:
+   build:
+      context: https://github.com/rishighan/threetwo-core-service.git
+   image: frishi/threetwo-core-service
+   container_name: core-services
+   ports:
+      - "3000:3000"
+      - "3001:3001"
+   depends_on:
+      - db
+      - redis
+      - elasticsearch
+   environment:
+      name: core-services
+      SERVICES: api,library,importqueue,settings,search,socket,imagetransformation,opds
+   env_file: /boot/config/plugins/compose.manager/projects/ThreeTwo/.env
+   volumes:
+      - *comics-volume
+      - *userdata-volume
+
+   networks:
+      - proxy
+
+db:
+   image: "bitnami/mongodb:latest"
+   container_name: database
+   networks:
+      - proxy
+   ports:
+      - "27017:27017"
+   volumes:
+      - "mongodb_data:/bitnami/mongodb"
+
+redis:
+   image: "bitnami/redis:latest"
+   container_name: queue
+   environment:
+      ALLOW_EMPTY_PASSWORD: "yes"
+   networks:
+      - proxy
+   ports:
+      - "6379:6379"
+
+elasticsearch:
+   image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2
+   container_name: elasticsearch
+   environment:
+      - "discovery.type=single-node"
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - "xpack.security.enabled=true"
+      - "xpack.security.authc.api_key.enabled=true"
+      - "ELASTIC_PASSWORD=password"
+   ulimits:
+      memlock:
+      soft: -1
+      hard: -1
+   ports:
+      - 9200:9200
+   networks:
+      - proxy
+
+networks:
+proxy:
+   external: true
+
+volumes:
+mongodb_data:
+   driver: local
+elastic:
+  driver: local
+   ```
+
+5. Click `Save Changes`
+6. Click `Compose Up` and check for errors.
+7. If all goes well, you should see the following containers appear as icons without images in the unRAID `Docker Containers` panel:
+   1. `threetwo-ui`
+   2. `core-services`
+   3. `metadata-service`
+   4. `elasticsearch`
+   5. `database`
+   6. `queue`
+8. You can look at the logs for these containers by clicking on their icons and then `Logs`
+
+### Ports
+
+1. `threetwo-ui`, runs on port 8050
+2. `threetwo-core-service` on 3000
+3. `threetwo-metadata-service` on 3080
+
+### Getting Updates
+
+Go to the `Docker Containers` tab from the unRAID web UI:
+
+1. Click on `Compose Down`, and let the command finish running.
+2. Click on `Compose Pull`, and let it finish running.
+3. Click on `Compose Up` to bring up the stack. 

docusaurus.config.js

@@ -53,11 +53,11 @@ const config = {
             type: 'doc',
             docId: 'intro',
             position: 'left',
-            label: 'Tutorial',
+            label: 'Quick Start',
           },
           {to: '/blog', label: 'Blog', position: 'left'},
           {
-            href: 'https://github.com/facebook/docusaurus',
+            href: 'https://github.com/rishighan/threetwo',
             label: 'GitHub',
             position: 'right',
           },
@@ -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/n4HZ4j33uT',
               },
             ],
           },
@@ -100,13 +96,16 @@ 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.`,
+      },
+      colorMode: {
+        disableSwitch: true,
       },
       prism: {
         theme: lightCodeTheme,

package.json

@@ -15,8 +15,8 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.6",
-    "@docusaurus/preset-classic": "^2.0.0-beta.6",
+    "@docusaurus/core": "^2.1.0",
+    "@docusaurus/preset-classic": "^2.1.0",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
@@ -27,7 +27,7 @@
     "url-loader": "^4.1.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.6",
+    "@docusaurus/module-type-aliases": "^2.1.0",
     "@tsconfig/docusaurus": "^1.0.4",
     "typescript": "^4.3.5"
   },

src/components/HomepageFeatures.module.css

@@ -6,6 +6,6 @@
 }
 
 .featureSvg {
-  height: 200px;
-  width: 200px;
+  min-height: 200px;
+  min-width: 200px;
 }

src/components/HomepageFeatures.tsx

@@ -16,32 +16,29 @@ type FeatureItem = {
 
 const FeatureList: FeatureItem[] = [
   {
-    title: 'Easy to Use',
-    image: '/img/undraw_docusaurus_mountain.svg',
+    title: 'Don\'t Hate, Curate.',
+    image: './img/curate.svg',
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        Browse, search, discover your comic book library that you have so proudly built from scratch.
       </>
     ),
   },
   {
-    title: 'Focus on What Matters',
-    image: '/img/undraw_docusaurus_tree.svg',
+    title: 'No Fuss DC++',
+    image: './img/dcpp.svg',
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        With first-class support for the excellent <code>AirDC++</code>, find and acquire hidden gems.
       </>
     ),
   },
   {
-    title: 'Powered by React',
-    image: '/img/undraw_docusaurus_react.svg',
+    title: 'Shine with Comic Vine',
+    image: './img/cv.svg',
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+        Scrape Comic Vine's exhaustive comic book database to analyze and clean up your library's metadata.
       </>
     ),
   },

src/pages/index.tsx

@@ -17,7 +17,7 @@ function HomepageHeader() {
           <Link
             className="button button--secondary button--lg"
             to="/docs/intro">
-            Docusaurus Tutorial - 5min ⏱️
+            Start Flipping! 
           </Link>
         </div>
       </div>