Skip to content

Latest commit

 

History

History
295 lines (205 loc) · 5.68 KB

SETUP.md

File metadata and controls

295 lines (205 loc) · 5.68 KB

📋 Setup & Development Guide

📖 Mục Lục

  1. Clone Repo
  2. Setup Backend
  3. Setup Frontend
  4. OpenAI API Configuration
  5. GitHub Secrets Setup
  6. Database Setup (XAMPP)
  7. Git Workflow
  8. Deploy to cPanel

🔄 Clone Repo

git clone https://github.com/leonthanh/my-project-FIXED.git
cd my-project-FIXED

🖥️ Setup Backend

Cài đặt Dependencies

cd backend
npm install

Tạo file .env

Tạo file backend/.env với nội dung:

DB_HOST=localhost
DB_NAME=wsxcblqh_ix
DB_USER=wsxcblqh_thanh
DB_PASS=
NODE_ENV=development
PORT=5000
EMAIL_USER=stareduelt@gmail.com
EMAIL_PASS=
EMAIL_TO=
REACT_APP_API_URL=http://localhost:5000
GEMINI_API_KEY=AIzaSyCNdfCuSNp6pG5281BxfP30ElK8oHDzob0
OPENAI_API_KEY=your_openai_api_key_here

Chạy Backend

npm start
# Hoặc dùng nodemon (tự reload khi thay đổi code)
npx nodemon server.js

Backend sẽ chạy ở: http://localhost:5000

🎨 Setup Frontend

Cài đặt Dependencies

cd frontend
npm install

Chạy Frontend

npm start

Frontend sẽ chạy ở: http://localhost:3000

🤖 OpenAI API Configuration

1. Tạo API Key

2. Cập nhật .env Local

# backend/.env
OPENAI_API_KEY=sk-proj-xxxxxxxxxxxx

3. Test AI Feature

  • Vào frontend: http://localhost:3000
  • Đăng nhập với tài khoản GV
  • Click nút "🤖 StarEdu AI gợi ý nhận xét"
  • Nếu thành công → AI sẽ trả về nhận xét chi tiết

🔐 GitHub Secrets Setup

Thêm Secrets vào GitHub

  1. Vào repo: https://github.com/leonthanh/my-project-FIXED
  2. Click Settings → Secrets and variables → Actions
  3. Click "New repository secret"
  4. Thêm các secrets sau:
Name Value
OPENAI_API_KEY sk-proj-xxxxxxxxxxxx
GEMINI_API_KEY AIzaSyCNdfCuSNp6pG5281BxfP30ElK8oHDzob0
EMAIL_USER stareduelt@gmail.com
EMAIL_PASS xxxx xxxx xxxx xxxx
FTP_USERNAME wsxcblqh
FTP_PASSWORD xxxxxxxxxxxx

⚠️ Quan trọng

  • KHÔNG bao giờ commit API Keys vào GitHub
  • Luôn dùng .gitignore để bỏ qua file .env
  • Secrets được lưu an toàn ở GitHub, chỉ dùng khi deploy

🗄️ Database Setup (XAMPP)

1. Cài đặt XAMPP

2. Tạo Database

  1. Mở phpMyAdmin: http://localhost/phpmyadmin
  2. Click "New"
  3. Tạo database: wsxcblqh_ix
  4. Character set: utf8mb4_unicode_ci

3. Tạo User MySQL

  1. Vào "User accounts"
  2. Click "Add user account"
  3. Nhập:
    • Username: wsxcblqh_thanh
    • Host: localhost
    • Password: @Thanh562184
  4. Click Go

4. Cấp quyền

  • Chọn user vừa tạo
  • Cấp "All privileges" cho database wsxcblqh_ix

📝 Git Workflow

✅ Quy trình làm việc chuẩn

Khi vào chỗ làm (sáng hôm sau)

cd d:/web-app/my-project-FIXED

# LUÔN pull trước!
git pull origin main

# Code của bạn...

Khi xong code

# Xem thay đổi
git status

# Thêm files
git add .

# Commit với message rõ ràng
git commit -m "Thêm feature XYZ"
# Hoặc
git commit -m "Fix lỗi ABC"

# Push lên GitHub
git push origin main

Khi sang PC khác (nhà)

# Trước khi code
git pull origin main

# Code...

# Commit & push
git add .
git commit -m "..."
git push origin main

⚠️ Lưu ý quan trọng

  • LUÔN git pull trước khi bắt đầu code
  • Tránh xung đột (conflict) khi 2 người code cùng lúc
  • Commit message nên rõ ràng, ngắn gọn

🚀 Deploy to cPanel

Workflow tự động

  • Khi bạn git push origin main
  • GitHub Actions tự động chạy
  • Deploy code lên cPanel (~5-10 phút)

Theo dõi Deploy

  1. Vào: https://github.com/leonthanh/my-project-FIXED
  2. Click tab "Actions"
  3. Xem workflow "Deploy to cPanel" chạy

Restart Server trên cPanel

Sau khi deploy xong:

  1. Đăng nhập cPanel
  2. Vào Setup Node.js App
  3. Chọn app → Click "Restart"
  4. Chờ ~30 giây để server khởi động lại

Kiểm tra Deploy thành công

# Truy cập app live
https://ix.star-siec.edu.vn

🛠️ Troubleshooting

Backend không chạy

# Kiểm tra port đã dùng
netstat -ano | findstr :5000

# Cài lại dependencies
rm -r node_modules package-lock.json
npm install

AI gợi ý không hoạt động

  • Kiểm tra OPENAI_API_KEY ở .env
  • Kiểm tra key còn quota không
  • Xem log backend: npm start (terminal)

Git conflict

# Nếu xảy ra xung đột
git pull origin main
# Sửa files conflict (mở file, chọn phần cần giữ)
git add .
git commit -m "Resolve conflict"
git push origin main

📚 Tài liệu tham khảo

Last Updated: 10/12/2025
Version: 1.0