ci(v4.0.0-alpha): 🚀 running the first ci worflow

.dockerignore

@@ -17,4 +17,6 @@ dist
 Dockerfile
 node_modules
 Thumbs.db
-tmp
+tmp
+tools/compose/*
+tools/scripts/*

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,86 @@
+name: 🐞 Bug Report
+
+description: Create a bug report to help improve Reactive Resume
+
+title: "[Bug] <title>"
+labels: [Bug, Needs Triage]
+assignees: "AmruthPillai"
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: Yes, I have searched the existing issues and none of them match my problem.
+          required: true
+
+  - type: dropdown
+    id: variant
+    attributes:
+      label: Product Variant
+      description: What variant of Reactive Resume are you using?
+      options:
+        - Cloud (http://rxresu.me)
+        - Self-Hosted
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Detailed steps to reproduce the behavior, so that it can be easily diagnosed.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: false
+
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+    validations:
+      required: false
+
+  - type: dropdown
+    id: template
+    attributes:
+      label: What template are you using?
+      multiple: false
+      options:
+        - Rhyhorn
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,23 @@
+name: ✨ Feature Request
+
+description: Suggest an feature or idea that you would like to see in Reactive Resume
+
+title: "[Feature] <title>"
+labels: [Feature, Needs Triage]
+assignees: "AmruthPillai"
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this feature?
+      description: Please search to see if an issue already exists for the feature you requested.
+      options:
+        - label: Yes, I have searched the existing issues and it doesn't exist.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Feature Description
+      description: A concise description of what feature you would like to see in Reactive Resume.
+    validations:
+      required: true

.github/workflows/publish-docker-image.yml

@@ -1,6 +1,9 @@
 name: Publish Docker Image
 
 on:
+  push:
+    branches:
+      - v4
   workflow_dispatch:
 
 env:

.vscode/settings.json

@@ -1,10 +1,9 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
-  "files.associations": {
-    "compose-dev.yml": "dockercompose",
-    ".github/workflows/*.yml": "github-actions-workflow"
-  },
   "yaml.schemas": {
-    "https://json.schemastore.org/github-workflow.json": "file:///Users/amruth/Projects/Reactive-Resume/.github/workflows/publish-docker-image.yml"
+    "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml",
+    "https://raw.githubusercontent.com/compose-spec/compose-spec/master/schema/compose-spec.json": [
+      "tools/compose/*"
+    ]
   }
 }

compose-dev.yml → tools/compose/dev.yml

@@ -1,5 +1,9 @@
 version: "3"
 
+# In this Docker Compose example, we only fire up the services required for local development.
+# This is not advised for production use as it exposes ports to the database insecurely.
+# If you're looking for a production-ready Docker Compose file, check out the `traefik.yml` file.
+
 services:
   # Database (Postgres)
   postgres:

compose.yml → tools/compose/simple.yml

@@ -1,5 +1,9 @@
 version: "3"
 
+# In this Docker Compose example, it assumes that you maintain a reverse proxy externally (or chose not to).
+# The only two exposed ports here are from minio (:9000) and the app itself (:3000).
+# If these ports are changed, ensure that the env vars passed to the app are also changed accordingly.
+
 services:
   # Database (Postgres)
   postgres:
@@ -46,11 +50,7 @@ services:
     command: redis-server --requirepass password
 
   app:
-    build:
-      context: .
-      dockerfile: Dockerfile
-      args:
-        - NX_CLOUD_ACCESS_TOKEN=${NX_CLOUD_ACCESS_TOKEN}
+    image: amruthpillai/reactive-resume
     restart: unless-stopped
     ports:
       - 3000:3000

tools/compose/traefik.yml

@@ -0,0 +1,123 @@
+version: "3"
+
+# In this Docker Compose example, we use Traefik to route requests to the app and storage containers.
+# This example assumes you have a domain name (example.com) and a wildcard DNS record pointing to your server.
+# The only exposed port here is from Traefik (80). If you choose to use SSL, check the Traefik docs for more info.
+# Note: Please change `example.com` to your domain name where necessary.
+
+services:
+  # Database (Postgres)
+  postgres:
+    image: postgres
+    restart: unless-stopped
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    healthcheck:
+      test: ["CMD", "pg_isready -U postgres -d postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  # Storage (for image uploads)
+  minio:
+    image: minio/minio
+    restart: unless-stopped
+    command: server /data
+    volumes:
+      - minio_data:/data
+    environment:
+      MINIO_ROOT_USER: minioadmin
+      MINIO_ROOT_PASSWORD: minioadmin
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.minio.rule=Host(`storage.example.com`)
+      - traefik.http.services.minio.loadbalancer.server.port=9000
+
+  # Chrome Browser (for printing and previews)
+  chrome:
+    image: browserless/chrome
+    restart: unless-stopped
+    environment:
+      TOKEN: chrome_token
+      EXIT_ON_HEALTH_FAILURE: true
+      PRE_REQUEST_HEALTH_CHECK: true
+
+  # Redis (for cache & server session management)
+  redis:
+    image: redis
+    restart: unless-stopped
+    command: redis-server --requirepass password
+
+  app:
+    build:
+      context: ../..
+      dockerfile: Dockerfile
+    restart: unless-stopped
+    ports:
+      - 3000:3000
+    depends_on:
+      - postgres
+      - minio
+      - redis
+      - chrome
+    environment:
+      # -- Environment Variables --
+      PORT: 3000
+      NODE_ENV: production
+      # -- URLs --
+      PUBLIC_URL: http://example.com
+      STORAGE_URL: http://storage.example.com
+      # -- Printer (Chrome) --
+      CHROME_URL: ws://chrome:3000
+      CHROME_TOKEN: chrome_token
+      # -- Database (Postgres) --
+      DATABASE_URL: postgresql://postgres:postgres@postgres:5432/postgres
+      # -- Auth --
+      ACCESS_TOKEN_SECRET: access_token_secret
+      REFRESH_TOKEN_SECRET: refresh_token_secret
+      # -- Emails --
+      SMTP_URL: smtp://user:pass@smtp:587 # Optional
+      # -- Storage (Minio) --
+      STORAGE_ENDPOINT: minio
+      STORAGE_PORT: 9000
+      STORAGE_REGION: us-east-1 # Optional
+      STORAGE_BUCKET: default
+      STORAGE_ACCESS_KEY: minioadmin
+      STORAGE_SECRET_KEY: minioadmin
+      # -- Cache (Redis) --
+      REDIS_URL: redis://default:password@redis:6379
+      # -- Sentry --
+      SENTRY_DSN: https://id.sentry.io # Optional
+      # -- GitHub --
+      GITHUB_CLIENT_ID: github_client_id
+      GITHUB_CLIENT_SECRET: github_client_secret
+      GITHUB_CALLBACK_URL: http://localhost:3000/api/auth/github/callback
+      # -- Google --
+      GOOGLE_CLIENT_ID: google_client_id
+      GOOGLE_CLIENT_SECRET: google_client_secret
+      GOOGLE_CALLBACK_URL: http://localhost:3000/api/auth/google/callback
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.app.rule=Host(`example.com`)
+      - traefik.http.services.app.loadbalancer.server.port=3000
+
+  traefik:
+    image: traefik
+    command:
+      - --api.insecure=true
+      - --providers.docker
+      - --providers.docker.exposedbydefault=false
+      - --entrypoints.web.address=:80
+    ports:
+      - 80:80
+      - 8080:8080
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+
+volumes:
+  minio_data:
+  postgres_data: