docs

.github/workflows/ci.yaml

@@ -2,21 +2,17 @@ name: CI
 
 on:
   pull_request:
-    branches: ["*"]
+    branches: ['*']
   push:
-    branches: ["main"]
+    branches: ['main']
   merge_group:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
-# You can leverage Vercel Remote Caching with Turbo to speed up your builds
-# @link https://turborepo.org/docs/core-concepts/remote-caching#remote-caching-on-vercel-builds
 env:
   FORCE_COLOR: 3
-  TURBO_TEAM: ${{ vars.TURBO_TEAM }}
-  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
   CI: true
 
 jobs:

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

@@ -6,13 +6,18 @@ on:
       - '**-dev'
 
 jobs:
-  api-build:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
-      - name: Docker meta
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver: docker-container
+
+      - name: Docker meta for API
         id: api-meta
         uses: docker/metadata-action@v5
         with:
@@ -23,29 +28,7 @@ jobs:
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
 
-      - name: Login to DockerHub
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Build and push API
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          file: ./docker/api.dockerfile
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.api-meta.outputs.tags }}
-          labels: ${{ steps.api-meta.outputs.labels }}
-
-  web-build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-
-      - name: Docker meta
+      - name: Docker meta for Web
         id: web-meta
         uses: docker/metadata-action@v5
         with:
@@ -63,11 +46,12 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Build and push Web
-        uses: docker/build-push-action@v6
+      - name: Bake and push multi-platform Docker images
+        uses: docker/bake-action@v4
         with:
-          context: .
-          file: ./docker/web.dockerfile
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.web-meta.outputs.tags }}
-          labels: ${{ steps.web-meta.outputs.labels }}
+          files: |
+            ./docker/docker-bake.hcl
+          push: true
+          set: |
+            api.tags=${{ steps.api-meta.outputs.tags }}
+            web.tags=${{ steps.web-meta.outputs.tags }}

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

@@ -8,55 +8,36 @@ on:
       - '!**-dev'
 
 jobs:
-  api-build:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
-      - name: Docker meta
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver: docker-container
+
+      - name: Docker meta for API
         id: api-meta
         uses: docker/metadata-action@v5
         with:
           images: line/abc-user-feedback-api
           tags: |
-            type=ref,event=branch
-            type=ref,event=pr
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
+            type=raw,value=latest
 
-      - name: Login to DockerHub
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Build and push API
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          file: ./docker/api.dockerfile
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.api-meta.outputs.tags }}
-          labels: ${{ steps.api-meta.outputs.labels }}
-
-  web-build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-
-      - name: Docker meta
+      - name: Docker meta for Web
         id: web-meta
         uses: docker/metadata-action@v5
         with:
           images: line/abc-user-feedback-web
           tags: |
-            type=ref,event=branch
-            type=ref,event=pr
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
+            type=raw,value=latest
 
       - name: Login to DockerHub
         if: github.event_name != 'pull_request'
@@ -65,11 +46,12 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Build and push Web
-        uses: docker/build-push-action@v6
+      - name: Bake and push multi-platform Docker images
+        uses: docker/bake-action@v4
         with:
-          context: .
-          file: ./docker/web.dockerfile
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.web-meta.outputs.tags }}
-          labels: ${{ steps.web-meta.outputs.labels }}
+          files: |
+            ./docker/docker-bake.hcl
+          push: true
+          set: |
+            api.tags=${{ steps.api-meta.outputs.tags }}
+            web.tags=${{ steps.web-meta.outputs.tags }}

README.md

@@ -4,31 +4,6 @@
 
 ABC User Feedback is a standalone web application designed to manage Voice of Customer (VoC) data. It enables you to efficiently gather and categorize customer feedback. The application is currently utilized in services with a reach of 10 million MAU.
 
-## Quick Start
-
-To quickly set up and run the application locally, follow these steps:
-
-1. **Clone the Repository**:
-
-   ```bash
-   git clone https://github.com/line/abc-user-feedback
-   cd abc-user-feedback
-   ```
-
-2. **Install Dependencies**:
-
-   ```bash
-   pnpm install
-   ```
-
-3. **Start the Application**:
-   ```bash
-   npx auf-cli init
-   npx auf-cli start
-   ```
-
-For more detailed setup instructions, refer to the [Getting Started](#getting-started) section.
-
 <p align="center">
   <video src="https://github.com/user-attachments/assets/a2ef7a1a-41ec-4cec-b7d1-bda5fbd7d48b" width="100%" />
 </p>
@@ -147,7 +122,7 @@ npm run migration:run
 pnpm dev
 ```
 
-### Build Docker Image
+### Option3. Build Docker Image
 
 For your code build, you can build a Docker image using Docker Compose. Refer to [remote caching](https://turbo.build/repo/docs/core-concepts/remote-caching) and [deploying with Docker](https://turbo.build/repo/docs/handbook/deploying-with-docker) using `turborepo`.
 

apps/cli/.gitignore

@@ -0,0 +1 @@
+abc-user-feedback

apps/cli/config.toml → apps/cli/bin/assets/config.toml

@@ -4,15 +4,17 @@ MYSQL_PRIMARY_URL="mysql://root:userfeedback@host.docker.internal:13306/userfeed
 OPENSEARCH_USE=true
 OPENSEARCH_NODE="http://localhost:9200"
 OPENSEARCH_USERNAME="UserFeedback123!@#"
-SMTP_HOST="localhost"
+OPENSEARCH_PASSWORD="UserFeedback123!@#"
+
+SMTP_HOST="smtp4dev"
 SMTP_PORT=25
 SMTP_SENDER="noreply@linecorp.com"
 SMTP_BASE_URL="http://localhost:3000"
+
 AUTO_MIGRATION=true
 NODE_OPTIONS="--max_old_space_size=3072"
 BASE_URL="http://localhost:3000"
 JWT_SECRET="secret"
-OPENSEARCH_PASSWORD="UserFeedback123!@#"
 MASTER_API_KEY="MASTER_API_KEY"
 
 [web]

apps/cli/bin/assets/docker-compose.generated.yml

@@ -0,0 +1,34 @@
+services:
+  web:
+    hostname: web
+    image: line/abc-user-feedback-web
+    restart: always
+    ports:
+      - 3000:3000
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'
+    environment:
+      - NEXT_PUBLIC_API_BASE_URL=http://localhost:4000
+      - NEXT_PUBLIC_MAX_DAYS=90
+    depends_on:
+      - api
+
+  api:
+    hostname: api
+    image: line/abc-user-feedback-api
+    restart: always
+    ports:
+      - 4000:4000
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'
+    environment:
+      - JWT_SECRET=secret
+      - MYSQL_PRIMARY_URL=mysql://root:userfeedback@host.docker.internal:13306/userfeedback
+      - BASE_URL=http://localhost:3000
+      - SMTP_HOST=smtp4dev
+      - SMTP_PORT=25
+      - SMTP_SENDER=noreply@linecorp.com
+      - SMTP_BASE_URL=http://localhost:3000
+      - AUTO_MIGRATION=true
+      - MASTER_API_KEY=MASTER_API_KEY
+      - NODE_OPTIONS=--max_old_space_size=3072

apps/cli/docker-compose.infra-amd64.yml → apps/cli/bin/assets/docker-compose.infra-amd64.yml

@@ -18,33 +18,7 @@ services:
     ports:
       - 13306:3306
     volumes:
-      - ./volumes/mysql:/var/lib/mysql
-    networks:
-      - app_network
-
-  # optional for e2e test
-  mysql-for-e2e:
-    hostname: mysql
-    image: mysql:8.0.39
-    platform: linux/amd64
-    restart: always
-    command:
-      [
-        '--default-authentication-plugin=mysql_native_password',
-        '--collation-server=utf8mb4_bin',
-      ]
-    environment:
-      MYSQL_ROOT_PASSWORD: userfeedback
-      MYSQL_DATABASE: e2e
-      MYSQL_USER: userfeedback
-      MYSQL_PASSWORD: userfeedback
-      TZ: UTC
-    ports:
-      - 13307:3306
-    volumes:
-      - ./volumes/mysql-for-e2e:/var/lib/mysql-for-e2e
-    networks:
-      - app_network
+      - mysql:/var/lib/mysql
 
   # optional for email verification on creating user
   smtp4dev:
@@ -55,15 +29,12 @@ services:
       - 25:25
       - 143:143
     volumes:
-      - ./volumes/smtp4dev:/smtp4dev
-    networks:
-      - app_network
+      - smtp4dev:/smtp4dev
 
   # optional for better performance on searching feedbacks
   opensearch-node:
-    image: opensearchproject/opensearch:2.15.0
+    image: opensearchproject/opensearch:2.16.0
     restart: always
-    container_name: opensearch-node
     environment:
       - cluster.name=opensearch-cluster
       - node.name=opensearch-node
@@ -80,27 +51,24 @@ services:
         soft: 65536
         hard: 65536
     volumes:
-      - ./volumes/opensearch:/usr/share/opensearch/data
+      - opensearch:/usr/share/opensearch/data
     ports:
       - 9200:9200
       - 9600:9600
-    networks:
-      - app_network
 
   # optional for opensearch
   opensearch-dashboards:
-    image: opensearchproject/opensearch-dashboards:2.15.0
+    image: opensearchproject/opensearch-dashboards:2.16.0
     restart: always
-    container_name: opensearch-dashboards
     ports:
       - 5601:5601
     environment:
       - 'OPENSEARCH_HOSTS=["http://opensearch-node:9200"]'
       - 'DISABLE_SECURITY_DASHBOARDS_PLUGIN=true'
     depends_on:
       - opensearch-node
-    networks:
-      - app_network
 
-networks:
-  app_network:
+volumes:
+  mysql:
+  smtp4dev:
+  opensearch: