Merge pull request #1561 from line/feat/docs

docs

Author: jihun

.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:
@@ -66,12 +62,9 @@ jobs:
           echo "JWT_SECRET=${{ vars.TEST_JWT_SECRET }}" >> ./apps/api/.env.test
           echo "OPENSEARCH_USE=true" >> ./apps/api/.env.test
           echo "OPENSEARCH_NODE=http://localhost:9200" >> ./apps/api/.env.test
-          echo "OPENSEARCH_USERNAME=''" >> ./apps/api/.env.test
-          echo "OPENSEARCH_PASSWORD=''" >> ./apps/api/.env.test
           echo "SMTP_HOST='localhost'" >> ./apps/api/.env.test
           echo "SMTP_PORT=25" >> ./apps/api/.env.test
           echo "SMTP_SENDER='[email protected]'" >> ./apps/api/.env.test
-          echo "SMTP_BASE_URL='http://localhost:3000'" >> ./apps/api/.env.test
 
       - name: Run Tests
         run: pnpm test
@@ -84,7 +77,6 @@ jobs:
           echo "SMTP_HOST='localhost'" >> ./apps/api/.env.test
           echo "SMTP_PORT=25" >> ./apps/api/.env.test
           echo "SMTP_SENDER='[email protected]'" >> ./apps/api/.env.test
-          echo "SMTP_BASE_URL='http://localhost:3000'" >> ./apps/api/.env.test
 
       - name: Run Tests
         run: pnpm test

.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@v5
 
-      - 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@v5
-
-      - 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,13 +8,18 @@ on:
       - '!**-dev'
 
 jobs:
-  api-build:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v5
 
-      - 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:
@@ -25,29 +30,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@v5
-
-      - name: Docker meta
+      - name: Docker meta for Web
         id: web-meta
         uses: docker/metadata-action@v5
         with:
@@ -65,11 +48,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/e2e-test.yml

@@ -39,16 +39,29 @@ jobs:
         ports:
           - 9200:9200
     steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - name: Setup e2e test
-        run: |
-          npm install -g corepack@latest
-          corepack enable
-          pnpm install --frozen-lockfile
-          pnpm playwright install
+      - name: Setup
+        uses: ./tooling/github/setup
+
+      - name: Cache Playwright browsers
+        uses: actions/cache@v3
+        id: playwright-cache
+        with:
+          path: ~/.cache/ms-playwright
+          key: ${{ runner.os }}-playwright-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install Playwright Browsers
+        if: steps.playwright-cache.outputs.cache-hit != 'true'
+        run: pnpm exec playwright install --with-deps chromium
 
       - name: Run e2e tests
         run: |
           CI=true pnpm test:e2e
+
+      - uses: actions/upload-artifact@v4
+        if: always() && !cancelled()
+        with:
+          name: playwright-report
+          path: apps/e2e/playwright-report/
+          retention-days: 7

.github/workflows/integration-test.yml

@@ -10,7 +10,7 @@ jobs:
 
     services:
       mysql:
-        image: mysql:8.0.39
+        image: mysql:8.0
         env:
           MYSQL_ROOT_PASSWORD: userfeedback
           MYSQL_DATABASE: e2e
@@ -49,24 +49,20 @@ jobs:
 
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Setup integration test (with opensearch)
         run: |
           npm install -g corepack@latest
           corepack enable
           pnpm install --frozen-lockfile
           pnpm build
-          echo "BASE_URL=http://localhost:3000" >> ./apps/api/.env
           echo "JWT_SECRET=DEV" >> ./apps/api/.env
           echo "OPENSEARCH_USE=true" >> ./apps/api/.env
           echo "OPENSEARCH_NODE=http://localhost:9200" >> ./apps/api/.env
-          echo "OPENSEARCH_USERNAME=''" >> ./apps/api/.env
-          echo "OPENSEARCH_PASSWORD=''" >> ./apps/api/.env
           echo "SMTP_HOST='localhost'" >> ./apps/api/.env
           echo "SMTP_PORT=25" >> ./apps/api/.env
           echo "SMTP_SENDER='[email protected]'" >> ./apps/api/.env
-          echo "SMTP_BASE_URL='http://localhost:3000'" >> ./apps/api/.env
 
       - name: Run integration tests (with opensearch)
         run: |

.github/workflows/publish-api-docs.yml

@@ -10,7 +10,7 @@ jobs:
 
     services:
       mysql:
-        image: mysql:8.0.39
+        image: mysql:8.0
         env:
           MYSQL_ROOT_PASSWORD: userfeedback
           MYSQL_DATABASE: userfeedback
@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Build app and swagger docs
         run: |
@@ -36,7 +36,7 @@ jobs:
       - name: Run Redocly CLI
         uses: fluximus-prime/redocly-cli-github-action@v1
         with:
-          args: "build-docs apps/api/swagger.json --output docs/index.html"
+          args: 'build-docs apps/api/swagger.json --output docs/index.html'
 
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3

.gitignore

@@ -44,9 +44,11 @@ volumes
 .cache
 
 # playwright
-playwright-report
-test-results
-user.json
+
+test-results/
+playwright-report/
+blob-report/
+playwright/
 
 # JetBrains
 .idea

README.md

@@ -2,31 +2,7 @@
 
 ![cover image](./assets/cover.png)
 
-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. With AI-powered insights, you can manage feedback more effectively. The application is currently utilized in services reaching 10 million monthly active users (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.
+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.
 
 <p align="center">
   <video src="https://github.com/user-attachments/assets/a2ef7a1a-41ec-4cec-b7d1-bda5fbd7d48b" width="100%" />
@@ -78,9 +54,7 @@ Before you begin, ensure you have the following installed:
 - SMTP - for mail verification during making accounts
 - [OpenSearch v2.16](https://opensearch.org/) - for performance on searching feedback
 
-You can use the [docker-compose.infra-amd64.yml](/docker/docker-compose.infra-amd64.yml) file for requirements.
-
-For ARM architecture, use the [docker-compose.infra-arm64.yml](/docker/docker-compose.infra-arm64.yml) file.
+You can use the [docker-compose.infra.yml](/docker/docker-compose.infra.yml) file for requirements.
 
 ### Docker Hub Images
 
@@ -149,7 +123,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/api/.env.example

@@ -3,10 +3,8 @@ JWT_SECRET=DEV
 
 MYSQL_PRIMARY_URL=mysql://userfeedback:userfeedback@localhost:13306/userfeedback # required
 
-BASE_URL=http://localhost:3000 # default: http://localhost:3000
-
 ACCESS_TOKEN_EXPIRED_TIME=10m # default: 10m
-REFESH_TOKEN_EXPIRED_TIME=1h # default: 1h
+REFRESH_TOKEN_EXPIRED_TIME=1h # default: 1h
 
 # Optional enviroment variables
 
@@ -17,22 +15,21 @@ REFESH_TOKEN_EXPIRED_TIME=1h # default: 1h
 
 SMTP_HOST=localhost # required
 SMTP_PORT=25 # required
+SMTP_SENDER=[email protected] # required
 # SMTP_USERNAME= # optional
 # SMTP_PASSWORD= # optional
-SMTP_SENDER=[email protected] # required
-SMTP_BASE_URL=http://localhost:3000 # required
 # SMTP_TLS= # default: false
 # SMTP_CIPHER_SPEC= # default: TLSv1.2 if SMTP_TLS=true
 # SMTP_OPPORTUNISTIC_TLS= # default: true if SMTP_TLS=true
 
 # OPENSEARCH_USE=false # default: false
 # OPENSEARCH_NODE= # required if OPENSEARCH_USE=true
-# OPENSEARCH_USERNAME= # required if OPENSEARCH_USE=true
-# OPENSEARCH_PASSWORD= # required if OPENSEARCH_USE=true
+# OPENSEARCH_USERNAME= # optional
+# OPENSEARCH_PASSWORD= # optional
 
 # AUTO_MIGRATION=true # default: true
 
 # MASTER_API_KEY= # default: none
 
-# ENABLE_AUTO_FEEDBACK_DELETION=false # default: false
+# AUTO_FEEDBACK_DELETION_ENABLED=false # default: false
 # AUTO_FEEDBACK_DELETION_PERIOD_DAYS=365*5