Update backend documents contents and scripts
This commit is contained in:
parent
9d5d941f07
commit
3c18af9d87
4 changed files with 32 additions and 8 deletions
14
Services/server/README.md
Normal file
14
Services/server/README.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# EDM Backend API
|
||||
Enterprise Document Management (EDM) ส่วน backend
|
||||
|
||||
# ส่วนประกอบ
|
||||
|
||||
- Node.js (TypeScript) และ Express เป็น Framework สำหรับการพัฒนาหลัก
|
||||
- pnpm เป็น package manager
|
||||
- Web API Doc สร้าง Open API Spec ด้วย tsoa
|
||||
- Library Document ใช้ TypeDoc
|
||||
- Minio สำหรับเก็บไฟล์ มีการใช้ presign url สำหรับ upload/download ทำให้รองรับโหลดได้มากตามความสามารถของ MiniO
|
||||
- Keycloak ทำ Single Sign On เพื่อ integrate กับระบบอื่น
|
||||
- Elasticsearch สำหรับการค้นหาเอกสารภาษาไทย
|
||||
- Attachment Processor สำหรับดึงข้อความเพื่อทำ Index สำหรับ Elasticsearch
|
||||
- RabbitMQ ทดลองย้ายการทำ index ไปอยู่ในคิวเพื่อทำให้รับโหลดเอกสารได้มากยิ่งขึ้น
|
||||
|
|
@ -1,14 +1,17 @@
|
|||
{
|
||||
"name": "test",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"name": "edm-api",
|
||||
"version": "0.1.0",
|
||||
"description": "Enterprise Document Management",
|
||||
"main": "src/app.ts",
|
||||
"scripts": {
|
||||
"format": "prettier --write .",
|
||||
"dev": "concurrently \"nodemon\" \"nodemon -x tsoa spec-and-routes\"",
|
||||
"build": "tsoa spec-and-route && tsc",
|
||||
"preview": "node ./dist/app.js",
|
||||
"serve": "node ./dist/app.js"
|
||||
"serve": "node ./dist/app.js",
|
||||
"docs":"npm run docs:typedoc && npm run docs:swagger",
|
||||
"docs:typedoc":"npx typedoc && scp -r typedoc projects-doc:~/projects/project-docs/edm/ && rm -r typedoc" ,
|
||||
"docs:swagger": "scp src/swagger.json projects-doc:~/projects/project-docs/edm/"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
|
|
|
|||
|
|
@ -14,5 +14,12 @@
|
|||
"experimentalDecorators": true,
|
||||
|
||||
"skipLibCheck": true
|
||||
},
|
||||
"typedocOptions": {
|
||||
"entryPoints": [
|
||||
"src/**/*.ts"
|
||||
],
|
||||
"out": "typedoc"
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,9 +8,9 @@
|
|||
"basePath": "/api",
|
||||
"spec": {
|
||||
"info": {
|
||||
"title": "BMA EHR - Test Service API",
|
||||
"version": "0.0.1",
|
||||
"description": "Best practice for initialize express project",
|
||||
"title": "Enterprise Document Management(EDM) - API",
|
||||
"version": "0.0.2",
|
||||
"description": "Open API Specfication for Enterprise Document Management ",
|
||||
"license": {
|
||||
"name": "by Frappet",
|
||||
"url": "https://frappet.com"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue