Hướng dẫn bắt đầu nhanh

Hướng dẫn này sẽ giúp bạn cài đặt và chạy dự án Waka-Bot trên máy cục bộ.

Yêu cầu

• Docker và Docker Compose
• Python 3.10+
• uv (hoặc pip)

Cài đặt

1. Clone a repository:

   git clone https://github.com/your-username/waka-bot.git && cd waka-bot
   

2. Cài đặt dependencies:

   Sử dụng uv để tạo môi trường ảo và cài đặt các gói cần thiết từ pyproject.toml.

   uv sync
   

3. Cấu hình môi trường:

   Sao chép tệp .env.sample thành .env và điền các giá trị cần thiết (API keys, thông tin cơ sở dữ liệu, ...).

   cp .env.sample .env
   

4. Chạy với Docker Compose:

   Cách đơn giản nhất để khởi chạy toàn bộ hệ thống (app, database, ...).

   docker compose up -d --build
   

5. Kiểm tra:

   Ứng dụng sẽ chạy tại http://localhost:8686. Bạn có thể truy cập http://localhost:8686/ping để kiểm tra xem dịch vụ đã hoạt động chưa.

   Truy cập http://localhost:8686/docs để xem tài liệu API tương tác (Swagger UI).

Chạy ứng dụng cục bộ (không dùng Docker)

Nếu bạn không muốn sử dụng Docker, bạn có thể chạy ứng dụng trực tiếp.

1. Khởi chạy server:

   uvicorn main:app --host 0.0.0.0 --port 8686 --reload
   

2. Chạy các services phụ thuộc:

   Bạn cần đảm bảo các dịch vụ khác như cơ sở dữ liệu (PostgreSQL) đang chạy và có thể truy cập được từ ứng dụng.