Init project document

This commit is contained in:
schooltechx 2023-11-16 11:28:50 +07:00
parent abe913b11a
commit e9aaec2947
4 changed files with 51 additions and 2 deletions

View file

@ -1,8 +1,29 @@
# Document
เอกสารของโครงการ
# Requirement
## Requirement
### ข้อกำหนดเบื้องต้น
- เป็น Stand alone Product ไม่ขึ้นกับโปรเจ็กอื่น
- มี Backend Frontend Document ใน repo เดียว
- Integrate กับโปรเจ็กอื่นๆได้ด้วย Single Sign On
- ถึงจะทำเพื่อลูกค้ารายเดียวแต่ให้ออกแบบให้ใช้ซ้ำได้ Backend คอนฟิกตามลูกค้าแต่ละรายได้ Frontend อาจจะมองเรื่องการเปลี่ยน Theme ไว้ด้วย (เป็นเรื่องรองไว้ทำทีหลังได้)
- ผู้ใช้งานมีสอง Roles
- dm_admin : เป็น role สำหรับจัดการ เพิ่ม ลบ แก้ไขจัดระเบียบ เอกสาร
- login user: บุคคลเข้าระบบได้ไม่ต้องมี role พิเศษใดๆ ค้นหาและดาว์นโหลดเอกสาร
อ่านเพิ่มเติมที่ไฟล์ [ระบบจัดเก็บข้อมูลผลการประเมินบุคคล (EV3)](./ระบบจัดเก็บข้อมูลผลการประเมินบุคคล%20(EV3).pdf), [db.png](./db.png)
## UI
[ดูใน Figma](https://www.figma.com/file/PilhhtvH4jbwwY12WRy74f/eHR?type=design&node-id=6671-3880&mode=design)
## Design Spec
Todo
## Tool
- Draw.io ทำไดอะแกรม
- ใช้ pandoc สร้างเอกสารจาก markdown
- Todo: script สำหรับ generate อัปโหลดเอกสารขึ้นเวปเอกสารกลาง

BIN
Document/db.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 292 KiB

View file

@ -1,3 +1,31 @@
# EDM
enterprise document management (EDM)
enterprise document management (EDM)
- [เอกสารโครงการ](./Document/Readme.md)
## Third party
คิดว่าน่าจะไม่ต้องใช้ฐานข้อมูล
- Minio
- Keycloak
- Elasticsearch
- RabbitMQ (อาจจะไม่ได้ใช้)
## Backend
- Node.js (TypeScript), Express ,
- Web API Doc สร้าย Open API Spec ด้วย tsoa
- Share Library Document ใช้ TypeDoc (ถ้ามี)
- Unit test ใช้ vitest (ยังไม่ยืนยัน)
## Frontend
- Vue (TypeScript)
- Unit test ใช้ vitest
- UI test Cypress
## Team
- อุ้ม
- โอ๊ต
- เตย
- เน็ต
- ภัท