chore: improve README, format files and add CI for formatting (#49)

* chore: improve README, format files and add CI for formatting * chore: fix ci
neumanf · Mar 3, 2024 · 4c042f0 · 4c042f0
1 parent 6dae46a
commit 4c042f0
Show file tree

Hide file tree

Showing 45 changed files with 27,561 additions and 32,660 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,42 +1,42 @@
 {
-  "root": true,
-  "ignorePatterns": ["**/*"],
-  "plugins": ["@nx"],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {
-        "@nx/enforce-module-boundaries": [
-          "error",
-          {
-            "enforceBuildableLibDependency": true,
-            "allow": [],
-            "depConstraints": [
-              {
-                "sourceTag": "*",
-                "onlyDependOnLibsWithTags": ["*"]
-              }
-            ]
-          }
-        ]
-      }
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "extends": ["plugin:@nx/typescript"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "extends": ["plugin:@nx/javascript"],
-      "rules": {}
-    },
-    {
-      "files": ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
-      "env": {
-        "jest": true
-      },
-      "rules": {}
-    }
-  ]
+    "root": true,
+    "ignorePatterns": ["**/*"],
+    "plugins": ["@nx"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {
+                "@nx/enforce-module-boundaries": [
+                    "error",
+                    {
+                        "enforceBuildableLibDependency": true,
+                        "allow": [],
+                        "depConstraints": [
+                            {
+                                "sourceTag": "*",
+                                "onlyDependOnLibsWithTags": ["*"]
+                            }
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "extends": ["plugin:@nx/typescript"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "extends": ["plugin:@nx/javascript"],
+            "rules": {}
+        },
+        {
+            "files": ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
+            "env": {
+                "jest": true
+            },
+            "rules": {}
+        }
+    ]
 }
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+apps/ui/src/themes/* linguist-vendored
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -0,0 +1,19 @@
+name: CD
+
+on:
+    push:
+        branches: ['main']
+
+env:
+    FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        defaults:
+            run:
+                working-directory: ./apps/api
+        steps:
+            - uses: actions/checkout@v3
+            - uses: superfly/flyctl-actions/setup-flyctl@master
+            - run: flyctl deploy --remote-only
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,14 @@
+name: CI
+
+on:
+    push:
+
+jobs:
+    format:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+            - run: npm install --only=dev
+            - run: npm run format
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
diff --git a/.prettierrc b/.prettierrc
@@ -1,6 +1,5 @@
 {
-  "singleQuote": true,
-  "tabWidth": 4,
-  "editor.formatOnSave": true,
-  "printWidth": 80
+    "singleQuote": true,
+    "tabWidth": 4,
+    "printWidth": 80
 }
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <!--suppress HtmlDeprecatedAttribute -->
 <p align="center">
   <a href="">
-    <img src="./frontend/public/logo.svg" height="220">
+    <img src="./apps/ui/src/assets/logo.svg" height="220">
   </a>
 </p>
 
@@ -14,16 +14,43 @@ A collection of open source web services
 
 ## Features
 
-- URL Shortener and Pastebin services
-- Authentication with JWT
-- User dashboard
-- CI/CD
-- Tests
+-   URL Shortener and Pastebin services
+-   CI/CD
+-   Tests
 
 ## Stack
 
-- **Frontend:** React, Next.js and Mantine
-- **Backend:** Nest.js, Prisma and PostgreSQL
+-   **Frontend:** Angular and PrimeNG.
+-   **Backend:** Springboot, RabbitMQ, PostgreSQL and Redis.
+
+## Architecture
+
+```mermaid
+---
+title: Mally Architecture
+---
+flowchart LR
+%% Styles
+    classDef app fill:#f7e081,stroke:#333,stroke-width:1px
+
+%% Entities
+    UI[UI - Angular]
+    POSTGRES[(PostgreSQL)]
+    API[API - Springboot]
+    RMQ[RabbitMQ]
+    REDIS[(Redis)]
+
+%% Flow
+    UI -->|HTTP|BACKEND
+    RMQ <-->|AMQP|BACKEND
+
+    subgraph BACKEND [API]
+        direction LR
+        API --> POSTGRES
+        API --> REDIS
+    end
+
+```
 
 ## License
 

diff --git a/apps/api/project.json b/apps/api/project.json
@@ -1,81 +1,65 @@
 {
-  "name": "api",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "apps/api/src",
-  "projectType": "application",
-  "targets": {
-    "build": {
-      "executor": "@nxrocks/nx-spring-boot:build",
-      "options": {
-        "root": "apps/api"
-      },
-      "dependsOn": [
-        "^install"
-      ],
-      "outputs": [
-        "{workspaceRoot}/apps/api/build"
-      ]
+    "name": "api",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "apps/api/src",
+    "projectType": "application",
+    "targets": {
+        "build": {
+            "executor": "@nxrocks/nx-spring-boot:build",
+            "options": {
+                "root": "apps/api"
+            },
+            "dependsOn": ["^install"],
+            "outputs": ["{workspaceRoot}/apps/api/build"]
+        },
+        "install": {
+            "executor": "@nxrocks/nx-spring-boot:install",
+            "options": {
+                "root": "apps/api"
+            },
+            "dependsOn": ["^install"],
+            "outputs": ["{workspaceRoot}/apps/api/build"]
+        },
+        "test": {
+            "executor": "@nxrocks/nx-spring-boot:test",
+            "options": {
+                "root": "apps/api"
+            },
+            "outputs": ["{workspaceRoot}/apps/api/build"]
+        },
+        "clean": {
+            "executor": "@nxrocks/nx-spring-boot:clean",
+            "options": {
+                "root": "apps/api"
+            }
+        },
+        "run": {
+            "executor": "@nxrocks/nx-spring-boot:run",
+            "options": {
+                "root": "apps/api"
+            },
+            "dependsOn": ["^install"]
+        },
+        "serve": {
+            "executor": "@nxrocks/nx-spring-boot:serve",
+            "options": {
+                "root": "apps/api"
+            },
+            "dependsOn": ["^install"]
+        },
+        "build-image": {
+            "executor": "@nxrocks/nx-spring-boot:build-image",
+            "options": {
+                "root": "apps/api"
+            },
+            "outputs": ["{workspaceRoot}/apps/api/build"]
+        },
+        "build-info": {
+            "executor": "@nxrocks/nx-spring-boot:build-info",
+            "options": {
+                "root": "apps/api"
+            }
+        }
     },
-    "install": {
-      "executor": "@nxrocks/nx-spring-boot:install",
-      "options": {
-        "root": "apps/api"
-      },
-      "dependsOn": [
-        "^install"
-      ],
-      "outputs": [
-        "{workspaceRoot}/apps/api/build"
-      ]
-    },
-    "test": {
-      "executor": "@nxrocks/nx-spring-boot:test",
-      "options": {
-        "root": "apps/api"
-      },
-      "outputs": [
-        "{workspaceRoot}/apps/api/build"
-      ]
-    },
-    "clean": {
-      "executor": "@nxrocks/nx-spring-boot:clean",
-      "options": {
-        "root": "apps/api"
-      }
-    },
-    "run": {
-      "executor": "@nxrocks/nx-spring-boot:run",
-      "options": {
-        "root": "apps/api"
-      },
-      "dependsOn": [
-        "^install"
-      ]
-    },
-    "serve": {
-      "executor": "@nxrocks/nx-spring-boot:serve",
-      "options": {
-        "root": "apps/api"
-      },
-      "dependsOn": [
-        "^install"
-      ]
-    },
-    "build-image": {
-      "executor": "@nxrocks/nx-spring-boot:build-image",
-      "options": {
-        "root": "apps/api"
-      },
-      "outputs": [
-        "{workspaceRoot}/apps/api/build"
-      ]
-    },
-    "build-info": {
-      "executor": "@nxrocks/nx-spring-boot:build-info",
-      "options": {
-        "root": "apps/api"
-      }
-    }
-  },
-  "tags": []
+    "tags": []
 }