Diva Group

Appearance

🚀 DIVA Backend: First Run Setup Guide ​

Tài liệu này hướng dẫn các bước thiết lập và khởi chạy dự án Backend DIVA cho developer mới.

1. Yêu cầu Hệ thống (System Requirements) ​

Đảm bảo máy tính của bạn đáp ứng các tiêu chuẩn sau trước khi clone source code:

  • Phần cứng: Tối thiểu 16GB RAM (bắt buộc để chạy mượt mà các container Docker & Hasura).
  • Hệ điều hành: Khuyến nghị sử dụng Linux (Ubuntu) để tối ưu hóa hiệu suất Docker daemon và tương thích tốt nhất với Makefile.
  • Phần mềm cần cài đặt:

2. Chuẩn bị Môi trường (Pre-requisites) ​

Trước khi chạy dự án, bạn cần liên hệ với Admin hoặc Technical Leader để nhận các file cấu hình bảo mật.

🔑 Tài liệu cần chuẩn bị ​

  1. Certificates: Nhận 2 file google-cert.json và onesignal.json.

    • Hành động: Đặt 2 file này vào thư mục: ./certs/dev/

  2. Environment Variables: Nhận file hoặc thông tin cấu hình biến môi trường.

    • Hành động: Điền đầy đủ các giá trị vào file .env.dev ở thư mục gốc của dự án.

  3. SSH Key: Tạo cặp khóa SSH (RSA) trên máy local để kết nối với Dev Machine.

    • Hành động: Chạy lệnh sau trên terminal nếu chưa có key:
    bash
    ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
    • Gửi Public Key (~/.ssh/id_rsa.pub) cho Admin/Tech Lead để được cấp quyền truy cập.

3. Thực thi Khởi chạy (Execution Steps) ​

Thực hiện tuần tự các bước sau trên terminal tại thư mục root của dự án:

Bước 1: Kiểm tra kết nối SSH ​

Kiểm tra xem máy local đã kết nối thành công với Dev Machine hay chưa:

bash
make ssh

IMPORTANT

Đảm bảo terminal trả về kết nối thành công trước khi tiếp tục.

Bước 2: Build & Start Services ​

Đảm bảo Docker daemon đang chạy. Khởi động toàn bộ cụm services (Golang, Hasura, Database, v.v.):

bash
make init start

TIP

Quá trình build ở lần chạy đầu tiên (pull images, build Go binaries, setup volumes) sẽ mất khoảng 5 đến 10 phút. Vui lòng giữ nguyên terminal.

Bước 3: Truy cập Controller ​

Sau khi các containers đã ở trạng thái Running và healthcheck pass, mở trình duyệt để truy cập: