fix readme

Truongpyeo · Dec 8, 2024 · 9b189b3 · 9b189b3
1 parent 5cebd8c
commit 9b189b3
Show file tree

Hide file tree

Showing 2 changed files with 263 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -188,15 +188,15 @@ Bạn có thể trải nghiệm ReliefLink tại: https://dz1.dzfullstack.com/
 Bạn có thể dùng các tài khoản sau để trải nghiệm:
 
 **Portal Người Dùng:**
-- Email: nguoidung@demo.com
+- Email: admin1@example.com
 - Password: 123456
 
 **Portal Nhân Lực:**
-- Email: nhanluc@demo.com  
+- Email: nhanlucA@example.com 
 - Password: 123456
 
 **Portal Admin:**
-- Email: admin@demo.com
+- Email: a@example.com
 - Password: 123456
 
 > **Lưu ý**: Đây là tài khoản demo chỉ có quyền hạn giới hạn. Để sử dụng đầy đủ tính năng, vui lòng đăng ký tài khoản mới.
@@ -221,7 +221,7 @@ relieflink/
 └── assets/         # Hình ảnh, tài nguyên
 ```
 ## 📖 Hướng dẫn chung
-   ### Document [Document](https://docs-relieflink.thanhtruongit.io.vn/DTU-Relieflink-documents/docs/intro)
+   ### Document [Document](docs/setup.md)
 
 ## 📚 Hướng dẫn cài đặt
 

diff --git a/docs/setup.md b/docs/setup.md
@@ -131,4 +131,262 @@ Nếu bạn muốn sử dụng MongoDB Atlas riêng:
 
 Tài liệu tham khảo:
 - [MongoDB Atlas Documentation](https://www.mongodb.com/docs/atlas/)
-- [Appsmith MongoDB Integration](https://docs.appsmith.com/reference/datasources/mongodb)
+- [Appsmith MongoDB Integration](https://docs.appsmith.com/reference/datasources/mongodb)
+
+## 🧩 Plugins
+### DTU AppSmith Map
+ -  NPM 
+```
+  npm install dtuappsmithmap
+```
+ -  CDN
+```
+  <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js"></script>
+```
+  - AppSmith
+    - Thêm URL sau vào Resource của Appsmith:
+```
+  https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js
+```
+Chi tiết hướng dẫn tại [DTUAppSmithMap](https://www.npmjs.com/package/dtuappsmithmap)
+
+### DTU AppSmith RealTime
+- NPM 
+```
+  npm install dtuappsmithrealtime
+```
+- CDN
+```
+  <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js"></script>
+```
+  
+- AppSmith
+  - Thêm URL sau vào Resource của Appsmith:
+```
+  https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js
+```
+Chi tiết hướng dẫn tại [DTUAppSmithRealTime](https://www.npmjs.com/package/dtuappsmithrealtime/v/1.1.5)
+
+Chi tiết cách cài đặt của AppSmith tại [AppSmith](https://docs.appsmith.com/core-concepts/writing-code/ext-libraries#prerequisites)
+
+## ⚙️ Services
+### DTU ServerSocket
+
+- Xem chi tiết tại [DTUServerSocket](https://github.com/Truongpyeo/DTUServerSocket)
+
+- Server Demo: [ServerDemo](https://socket.thanhtruongit.io.vn/login.html)
+
+## 🐳 Docker Appsmith
+### Yêu cầu tiên quyết
+ - Docker (phiên bản 20.10.7 trở lên)  [Docker]( https://docs.docker.com/get-docker/)
+ - Docker-Compose (phiên bản 1.29.2 trở lên) [Docker-Compose](https://docs.docker.com/compose/install/)
+
+Bạn sẽ cần phải khởi động lại máy tính sau khi hoàn tất quá trình cài đặt.
+
+- Clone repo của Appsmith từ GitHub về máy tính: 
+``` 
+    git clone https://github.com/appsmithorg/appsmith.git
+
+```
+
+- Nếu git clone về không có docker-compose.yml thì bạn cần tạo 1 file docker-compose.yml và cấu hình sau: 
+	version: "3"
+
+  ```
+  services:
+    appsmith:
+        image: index.docker.io/appsmith/appsmith-ee
+        container_name: appsmith
+        ports:
+            - "5555:80"
+            - "444:443"
+        volumes:
+            - ./stacks:/appsmith-stacks
+        restart: unless-stopped
+    mysql:
+        image: mysql:latest
+        ports:
+            - "33088:3306" 
+        container_name: mysql
+        environment:
+            - MYSQL_ROOT_PASSWORD=admin
+            - MYSQL_DATABASE=appsmith
+        volumes:
+            - mysql-data:/var/lib/mysql
+        restart: unless-stopped
+        volumes:
+        mysql-data:
+  ```
+
+
+
+- Trong thư mục appsmith, chạy lệnh sau để khởi động Appsmith trong Docker:
+
+``` 
+  cd appsmith
+  docker-compose up
+```
+Sau khi các container đã được khởi động, bạn có thể truy cập Appsmith qua trình duyệt.
+
+- Mở trình duyệt và vào địa chỉ:
+
+    - Truy cập Appsmith trên cổng http://localhost:5555 (HTTP) và http://localhost:444 (HTTPS).
+
+    - Truy cập MySQL trên cổng http://localhost:33088.
+
+Xem chi tiết tại [Docker Appsmith](https://docs.appsmith.com/getting-started/setup/installation-guides/docker)
+
+## 🧩 Plugins
+### DTU AppSmith Map
+ -  NPM 
+```
+  npm install dtuappsmithmap
+```
+ -  CDN
+```
+  <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js"></script>
+```
+  - AppSmith
+    - Thêm URL sau vào Resource của Appsmith:
+```
+  https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js
+```
+Chi tiết hướng dẫn tại [DTUAppSmithMap](https://www.npmjs.com/package/dtuappsmithmap)
+
+### DTU AppSmith RealTime
+- NPM 
+```
+  npm install dtuappsmithrealtime
+```
+- CDN
+```
+  <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js"></script>
+```
+  
+- AppSmith
+  - Thêm URL sau vào Resource của Appsmith:
+```
+  https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js
+```
+Chi tiết hướng dẫn tại [DTUAppSmithRealTime](https://www.npmjs.com/package/dtuappsmithrealtime/v/1.1.5)
+
+Chi tiết cách cài đặt của AppSmith tại [AppSmith](https://docs.appsmith.com/core-concepts/writing-code/ext-libraries#prerequisites)
+
+## ⚙️ Services
+### DTU ServerSocket
+
+- Xem chi tiết tại [DTUServerSocket](https://github.com/Truongpyeo/DTUServerSocket)
+
+- Server Demo: [ServerDemo](https://socket.thanhtruongit.io.vn/login.html)
+
+## 🐳 Docker Appsmith
+### Yêu cầu tiên quyết
+ - Docker (phiên bản 20.10.7 trở lên)  [Docker]( https://docs.docker.com/get-docker/)
+ - Docker-Compose (phiên bản 1.29.2 trở lên) [Docker-Compose](https://docs.docker.com/compose/install/)
+
+Bạn sẽ cần phải khởi động lại máy tính sau khi hoàn tất quá trình cài đặt.
+
+- Clone repo của Appsmith từ GitHub về máy tính: 
+``` 
+    git clone https://github.com/appsmithorg/appsmith.git
+
+```
+
+- Nếu git clone về không có docker-compose.yml thì bạn cần tạo 1 file docker-compose.yml và cấu hình sau: 
+	version: "3"
+
+  ```
+  services:
+    appsmith:
+        image: index.docker.io/appsmith/appsmith-ee
+        container_name: appsmith
+        ports:
+            - "5555:80"
+            - "444:443"
+        volumes:
+            - ./stacks:/appsmith-stacks
+        restart: unless-stopped
+    mysql:
+        image: mysql:latest
+        ports:
+            - "33088:3306" 
+        container_name: mysql
+        environment:
+            - MYSQL_ROOT_PASSWORD=admin
+            - MYSQL_DATABASE=appsmith
+        volumes:
+            - mysql-data:/var/lib/mysql
+        restart: unless-stopped
+        volumes:
+        mysql-data:
+  ```
+
+
+
+- Trong thư mục appsmith, chạy lệnh sau để khởi động Appsmith trong Docker:
+
+``` 
+  cd appsmith
+  docker-compose up
+```
+Sau khi các container đã được khởi động, bạn có thể truy cập Appsmith qua trình duyệt.
+
+- Mở trình duyệt và vào địa chỉ:
+
+    - Truy cập Appsmith trên cổng http://localhost:5555 (HTTP) và http://localhost:444 (HTTPS).
+
+    - Truy cập MySQL trên cổng http://localhost:33088.
+
+Xem chi tiết tại [Docker Appsmith](https://docs.appsmith.com/getting-started/setup/installation-guides/docker)
+
+
+
+## 💡Nhà phát triển
+
+- 📧 Email: [email protected]
+
+- 📱 Hotline: 0376 659 652
+
+*" 🏫 DTU_DZ - DUY TAN UNIVERSITY - SCS ✨"*
+
+## 📞 Liên hệ
+- Lê Thanh Trường       :  <u>[email protected]</u>
+- Võ Văn Việt           :  <u>[email protected]</u>
+- Nguyễn Ngọc Duy Thái  :  <u>[email protected]</u>
+
+## 📚 Tài liệu
+- [Hướng dẫn cài đặt](https://github.com/Truongpyeo/DTURelifeLink/blob/master/docs/setup.md)
+- [Hướng dẫn đóng góp](/CONTRIBUTING.md)
+
+## 🤝 Đóng góp
+Chúng tôi rất hoan nghênh mọi đóng góp! Xem [CONTRIBUTING](/CONTRIBUTING.md) để biết thêm chi tiết.
+
+## 🔄 Quy trình phát triển
+1. Fork repo này
+2. Tạo branch mới (`git checkout -b feature/AmazingFeature`)
+3. Commit thay đổi (`git commit -m 'Add some AmazingFeature'`)
+4. Push lên branch (`git push origin feature/AmazingFeature`) 
+5. Tạo Pull Request
+
+## 🐛 Báo lỗi
+Nếu bạn phát hiện lỗi, vui lòng tạo issue mới với:
+- Mô tả chi tiết lỗi
+- Các bước tái hiện
+- Screenshots nếu có
+- Môi trường (browser, OS...)
+
+## 📜 Changelog
+Xem [CHANGELOG](/CHANGELOG.md) để biết lịch sử thay đổi.
+
+## ⚖️ Code of Conduct
+Xem [CODE_OF_CONDUCT]/(CODE_OF_CONDUCT.md) để biết các quy tắc và hành vi được chấp nhận.
+
+## Báo cáo lỗi & Góp ý
+- Issues: [GitHub Issues](https://github.com/Truongpyeo/DTURelifeLink/issues)
+- Security: Đối với các vấn đề bảo mật nhạy cảm, vui lòng liên hệ trực tiếp qua email: <u>[email protected]</u>
+
+
+### 📝 License
+Dự án được phân phối dưới giấy phép [MIT License](/LICENSE)
+
+*"Được phát triển với ❤️ bởi Nhóm DTU-DZ"*