docs: add project overview

2026-04-26 10:05:41 +07:00
parent bca709b071
commit bdd83f8c35
2 changed files with 77 additions and 0 deletions
@@ -0,0 +1,45 @@
+# LMS Backend
+
+โปรเจกต์ **lms-backend** เป็นระบบ Backend / Back Office  
+สำหรับรองรับการบริหารจัดการ **Learning Management System (LMS)**
+
+ระบบนี้ถูกออกแบบเพื่อ:
+- รองรับการจัดการข้อมูลผู้ใช้งาน เนื้อหา และการเรียนรู้
+- ทำหน้าที่เป็น Back Office สำหรับ **LMS สาธารณะ** ที่มีแผนพัฒนาและเปิดให้ใช้งานในอนาคต
+- รองรับการพัฒนาและขยายระบบในระยะยาว
+
+---
+
+## Purpose
+
+- เป็นศูนย์กลางการจัดการระบบ LMS
+- รองรับการเชื่อมต่อกับ Frontend และบริการอื่นในอนาคต
+- ออกแบบให้เหมาะกับการใช้งานในระดับองค์กรและสาธารณะ
+
+---
+
+## Technical Overview
+
+- Backend Framework: Django
+- Containerization: Docker
+- CI: Gitea Actions
+- Deployment: Kubernetes (k3s) + GitOps (ArgoCD)
+
+---
+
+## Deployment Model
+
+โปรเจกต์นี้ใช้แนวทาง **CI/CD + GitOps**
+
+- Source code ใช้ Gitea
+- Build Docker Image และจัดเก็บใน Docker Hub
+- การ deploy ควบคุมผ่าน GitOps repository (`lms-k8s`)
+- ArgoCD ทำหน้าที่ deploy ไปยัง Kubernetes cluster
+
+---
+
+## Notes
+
+- Repository นี้โฟกัสเฉพาะ Backend / Back Office
+- Configuration และ Kubernetes manifests แยกอยู่ใน GitOps repository
+- โครงสร้างระบบถูกออกแบบให้พร้อมรองรับ LMS สาธารณะในอนาคต