From 09412508672ec99614751dc63ba26d5bcbdfba16 Mon Sep 17 00:00:00 2001
From: Tola Leng <tolaleng.oss@gmail.com>
Date: Sun, 13 Jul 2025 18:32:45 +0700
Subject: [PATCH] Refactor Split README and CONTRIBUTING into smaller
 components with support for multi languages

---
 CONTRIBUTING.md                               |  33 ++++
 README.md                                     |  33 ++++
 CONTRIBUTING_ja.md => docs/CONTRIBUTING_ja.md |  34 ++++
 docs/CONTRIBUTING_km.md                       | 181 +++++++++++++++++
 README_ja.md => docs/README_ja.md             |  33 ++++
 docs/README_km.md                             | 182 ++++++++++++++++++
 6 files changed, 496 insertions(+)
 rename CONTRIBUTING_ja.md => docs/CONTRIBUTING_ja.md (85%)
 create mode 100644 docs/CONTRIBUTING_km.md
 rename README_ja.md => docs/README_ja.md (89%)
 create mode 100644 docs/README_km.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0b8d2c3..f809209 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,36 @@
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="CONTRIBUTING.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="docs/CONTRIBUTING_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="docs/CONTRIBUTING_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
 
 # 🛠️ Contributing to CheckCle
 
diff --git a/README.md b/README.md
index 2d5c9bd..2bdff25 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="README.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="docs/README_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="docs/README_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
+
 ![CheckCle Platform](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/server-detail-page.png)
 
 # 🚀 What is CheckCle?
diff --git a/CONTRIBUTING_ja.md b/docs/CONTRIBUTING_ja.md
similarity index 85%
rename from CONTRIBUTING_ja.md
rename to docs/CONTRIBUTING_ja.md
index 82a5133..80461f7 100644
--- a/CONTRIBUTING_ja.md
+++ b/docs/CONTRIBUTING_ja.md
@@ -1,3 +1,37 @@
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="../CONTRIBUTING.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="CONTRIBUTING_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="CONTRIBUTING_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
+
 # 🛠️ CheckCleへの貢献
 
 **CheckCle**への貢献にご興味をお持ちいただき、ありがとうございます — リアルタイムフルスタック監視のための究極のオープンソースプラットフォームです。バグの報告、機能の提案、ドキュメントの改善、またはコードの提出など、どのような形でのご貢献でも歓迎いたします！
diff --git a/docs/CONTRIBUTING_km.md b/docs/CONTRIBUTING_km.md
new file mode 100644
index 0000000..78efbbb
--- /dev/null
+++ b/docs/CONTRIBUTING_km.md
@@ -0,0 +1,181 @@
+
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="../CONTRIBUTING.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="CONTRIBUTING_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="CONTRIBUTING_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
+
+# 🛠️ Contributing to CheckCle
+
+Thank you for your interest in contributing to **CheckCle** — the ultimate open-source platform for real-time full-stack monitoring. Whether you're here to report bugs, suggest features, improve documentation, or submit code, your contribution matters!
+
+We welcome all kinds of contributions, big or small. This guide will help you get started.
+
+---
+
+## 📌 Table of Contents
+- [Code of Conduct](#-code-of-conduct)
+- [Ways to Contribute](#-ways-to-contribute)
+- [Development Setup](#-development-setup)
+- [Pull Request Process](#-pull-request-process)
+- [Reporting Bugs & Issues](#-reporting-bugs--issues)
+- [Feature Requests](#-feature-requests)
+- [Community & Support](#-community--support)
+- [License](#-license)
+
+---
+
+## 📜 Code of Conduct
+
+We follow a [Code of Conduct](https://opensource.guide/code-of-conduct/) to foster an open and welcoming community. By participating, you agree to uphold these standards.
+
+---
+
+## 🤝 Ways to Contribute
+
+Here are some ways you can help improve CheckCle:
+
+- 🐞 **Report Bugs** – Found a glitch? Let us know by opening a [GitHub Issue](https://github.com/operacle/checkcle/issues).
+- 🌟 **Suggest Features** – Have an idea? Start a [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue.
+- 🛠 **Submit Pull Requests** – Improve the code, fix bugs, add features, or enhance the docs.
+- 📝 **Improve Documentation** – Even a typo fix helps!
+- 🌍 **Spread the Word** – Star ⭐ the repo, share it on socials, and invite others to contribute!
+
+---
+
+## 🧰 Development Setup
+
+Before contributing code, set up the project locally:
+
+### 1. Fork the Repository
+Click "Fork" on [GitHub](https://github.com/operacle/checkcle) to create your own copy.
+
+### 2. Clone Your Fork
+```bash
+git clone --branch develop https://github.com/operacle/checkcle.git
+cd checkcle
+```
+
+### 3. Install Dependencies
+Follow the instructions in the README or project docs to install required packages and run the local development server.
+
+### 4. Start Local Development
+```bash
+#Web Application
+cd application/ 
+npm install && npm run dev
+
+#Server Backend
+cd server
+./pocketbase serve --dir pb_data 
+
+If you're not using localhost, please run with this (./pocketbase serve --http=0.0.0.0:8090 --dir pb_data)
+```
+
+### 4. Start Service Check Operation
+
+```bash
+#Server Backend 
+Start Service Operation (Check Service for PING, HTTP, TCP, DNS)
+
+cd server/service-operation
+
+go run main.go (you do not need to change the .env while it's the localhost connection)
+```
+
+### 5. Start Distributed Regional Agent
+```bash
+#### 1. Fork the Repository
+Click "Fork" on [GitHub](https://github.com/operacle/Distributed-Regional-Monitoring) to create your own copy.
+
+#### 2. Clone Your Fork
+git clone --branch main https://github.com/operacle/Distributed-Regional-Monitoring.git
+cd Distributed-Regional-Monitoring
+
+#### 3. Install Go Service (make sure you have installed the Go Service)
+
+Copy .env.example -> .env
+Change regional agent configuration in .env file
+and Run: go run main.go
+
+```
+---
+
+## ✅ Pull Request Process
+
+1. Ensure your code follows the existing style and naming conventions.
+2. Write clear, concise commit messages.
+3. Push your branch and open a Pull Request (PR) on the `develop` branch.
+4. Provide a meaningful PR description (what/why/how).
+5. Link related issues if applicable (e.g. `Closes #12`).
+6. Make sure all checks pass (e.g., linting, tests).
+
+We’ll review your PR, request changes if needed, and merge it once ready!
+
+---
+
+## 🐛 Reporting Bugs & Issues
+
+Please include as much information as possible:
+- A clear, descriptive title
+- Steps to reproduce
+- Expected vs actual behavior
+- Environment info (OS, browser, device, etc.)
+- Screenshots or logs if applicable
+
+Use the [Issue Tracker](https://github.com/operacle/checkcle/issues) to report.
+
+---
+
+## 💡 Feature Requests
+
+We’d love to hear your ideas! Open a [Discussion](https://github.com/operacle/checkcle/discussions) or Feature Request issue. Make sure it’s not already listed in the [Roadmap](https://github.com/operacle/checkcle#development-roadmap).
+
+---
+
+## 🌍 Community & Support
+
+Need help? Want to connect?
+
+- 💬 [Join our Discord](https://discord.gg/xs9gbubGwX)
+- 🗣 Start or join a [GitHub Discussion](https://github.com/operacle/checkcle/discussions)
+- 🐦 Follow us on [X (Twitter)](https://x.com/tl)
+
+---
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
+
+---
+
+## 🙏 Thank You
+
+We’re excited to build CheckCle together — a powerful monitoring platform **for the community, by the community**. Your support means the world! 💙
diff --git a/README_ja.md b/docs/README_ja.md
similarity index 89%
rename from README_ja.md
rename to docs/README_ja.md
index 8009ec1..f2c6938 100644
--- a/README_ja.md
+++ b/docs/README_ja.md
@@ -1,3 +1,36 @@
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="../README.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="README_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="README_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
+
 ![CheckCle Platform](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/server-detail-page.png)
 
 # 🚀 CheckCleとは？
diff --git a/docs/README_km.md b/docs/README_km.md
new file mode 100644
index 0000000..f605d66
--- /dev/null
+++ b/docs/README_km.md
@@ -0,0 +1,182 @@
+## 🌐 Select Language
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <a href="../README.md">
+        <img src="https://flagcdn.com/24x18/gb.png" alt="English" />  
+        <br/><strong>English</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="README_km.md">
+        <img src="https://flagcdn.com/24x18/kh.png" alt="Khmer" />  
+        <br/><strong>ខ្មែរ</strong>
+      </a>
+    </td>
+    <td align="center">
+      <a href="README_ja.md">
+        <img src="https://flagcdn.com/24x18/jp.png" alt="Japanese" />  
+        <br/><strong>Japanese</strong>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<p align="center">
+  Thank you to all our contributors, users, and supporters for making this project thrive.
+</p>
+
+<p align="center">
+  🚀 <strong>Stay tuned for more updates, features, and improvements.</strong>
+</p>
+
+![CheckCle Platform](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/server-detail-page.png)
+
+# 🚀 តើឆេកខលគឺជាអ្វី?
+
+ឆេកខល (CheckCle) គឺជាប្រពន័្ធប្រភពបើកចំហមួយដែលបើកអោយប្រើប្រាស់ទូទាំងពីភពលោកដោយឥតគិតថ្លៃ ដែលមានក្នុងមុខងារចំបងក្នុងការត្រួតពិនិត្យវ៉េបសាយ កម្មវិធីបច្ចេកវិទ្យា​និងហេដ្ឋារចនាសម្ព័ន្ធនៃម៉ាសុីនមេជាដើម។ វាផ្តល់ឱ្យអ្នកអភិវឌ្ឍន៍ អ្នកគ្រប់គ្រងប្រព័ន្ធ និងក្រុម DevOps នូវការពត័ស៊ីជម្រៅ និងទិន្នន័យនៃហេដ្ឋារចនាសម្ព័ន្ធ មិនថាជាម៉ាស៊ីនមេ កម្មវិធី ឬសេវាកម្មនោះទេ។ ជាមួយ CheckCle អ្នកមើលឃើញជាក្រាប វិភាគ​ និងហេតុការផ្សេងៗ​ និងធានាបាននូវការជូនដំណើរការនៅហេតុការផ្សេងៗដែលបានកើតឡើង។
+
+## 🎯 តេស្តសាកល្បងផ្ទាល់
+👉 **Try it now:** [CheckCle Live Demo](https://demo.checkcle.io)
+
+## 🌟 មុខងារចម្បង
+
+### ពិនិត្យប្រព័ន្ធវ៉េបសាយ និងការត្រួតពិនិត្យហេដ្ឋារចនាសម្ព័ន្ធនៃម៉ាស៊ីនមេ
+- ត្រួតពិនិត្យពិធីកម្មវិធី HTTP, DNS, and Ping protocols
+- ត្រួតពិនិត្យពិធីកម្មវិធី TCP-based, API services (e.g., FTP, SMTP, HTTP)
+- តាមដាននិងវិភាគលម្អិត, response times, and performance issues
+- តាមដាននិងវិភាគលម្អិតពីដំបន់ឬប្រទេសផ្សេងៗបាន
+- ប្រវត្តិឧប្បត្តិហេតុ (UP/DOWN/WARNING/PAUSE)
+- តាមដាន​ SSL & Domain (Domain, Issuer, Expiration Date, Days Left, Status, Last Notified)
+- តាមដាននិងត្រួតពិនិត្យម៉ាស៊ីនមេ, Supports Linux (🐧 Debian, Ubuntu, CentOS, Red Hat, etc.) and Windows (Beta). And Servers metrics like CPU, RAM, disk usage, and network activity) with an one-line installation angent script.
+- រៀបចំកាលវិភាគ និងការគ្រប់គ្រងឧប្បត្តិហេតុ
+- ទំព័រស្ថានភាពប្រតិបត្តិការ
+- ការជូនដំណឹងតាមរយៈ email, Telegram, Discord, and Slack
+- របាយការណ៍ & វិភាគលម្អិត
+- ផ្ទាំងការកំណត់ប្រព័ន្ធគ្រប់គ្រង (User Management, Data Retention, Multi-language, Themes (Dark & Light Mode), Notification and channels and alert templates).
+
+## #️⃣ ការចាប់ផ្តើម
+
+### ដំណើរការលើស្ថាបត្យកម្មដូចជា
+* ✅ x86_64 PCs, laptops, servers (amd64)
+* ✅ Modern Raspberry Pi 3/4/5 with (64-bit OS), Apple Silicon Macs (arm64)
+
+### អ្នកអាចដំឡើង CheckCle ដោយជ្រើសរើសជម្រើសមួយក្នុងចំណោមជម្រើសខាងក្រោម។
+
+
+1. CheckCle One-Click Installation - Just copy and run on terminal
+```bash 
+curl -fsSL https://checkcle.io/install.sh | bash
+
+```
+2. Install with docker run. Just copy ready docker run command below
+```bash 
+docker run -d \
+  --name checkcle \
+  --restart unless-stopped \
+  -p 8090:8090 \
+  -v /opt/pb_data:/mnt/pb_data \
+  --ulimit nofile=4096:8192 \
+  operacle/checkcle:latest
+
+```
+3. Install with Docker compose Configuration.
+```bash 
+
+version: '3.9'
+
+services:
+  checkcle:
+    image: operacle/checkcle:latest
+    container_name: checkcle
+    restart: unless-stopped
+    ports:
+      - "8090:8090"  # Web Application
+    volumes:
+      - /opt/pb_data:/mnt/pb_data  # Host directory mapped to container path
+    ulimits:
+      nofile:
+        soft: 4096
+        hard: 8192
+
+```
+3. ចូលទៅកាន់ផ្ទាំងគ្រប់គ្រង
+
+    Default URL: http://0.0.0.0:8090
+    User: admin@example.com
+    Passwd: Admin123456
+    
+4. ឯកសារ​ និងរបៀបប្រើប្រាស់ផ្សេង at https://docs.checkcle.io
+
+###
+![checkcle-collapse-black](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/uptime-monitoring.png)
+![Service Detail Page](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/uptime-service-detail.png)
+![checkcle-server-instance](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/instance-server-monitoring.png)
+![Schedule Maintenance](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/checkcle-schedule-maintenance.png)
+![SSL Monitoring](https://pub-4a4062303020445f8f289a2fee84f9e8.r2.dev/images/ssl-monitoring.png)
+
+## 📝 គម្រោងក្នុងការអភិវឌ្ឍន៍ប្រព័ន្ធគ្រប់គ្រង
+
+- ✅ Health check & uptime monitoring (HTTP)
+- ✅ Dashboard UI with live stats  
+- ✅ Auth with Multi-users system (admin)
+- ✅ Notifications (Telegram)
+- ✅ Docker containerization 
+- ✅ CheckCle Website
+- ✅ CheckCle Demo Server
+- ✅ SSL & Domain Monitoring
+- ✅ Schedule Maintenance 
+- ✅ Incident Management
+- [ ] Infrastructure Server Monitoring
+- ✅ Operational Status / Public Status Pages
+- ✅ Uptime monitoring (HTTP, TCP, PING, DNS) Full functionality
+- ✅ Distributed Regional Monitoring Agent [Support Operation](https://github.com/operacle/Distributed-Regional-Monitoring)
+- ✅ System Setting Panel and Mail Settings
+- ✅ User Permission Roles
+- [ ] Notifications (Email/Slack/Discord/Signal)  
+- ✅ Data Retention & Automate Strink (Muti Options to Shrink Data & Database )
+- ✅ Open-source release with full documentation 
+
+## 🌟 ឆេកខលសម្រាប់សហគមន៍
+- **Built with Passion**: Created by an open-source enthusiast for the community
+- **Free & Open Source**: Completely free to use with no hidden costs
+- **Collaborate & Connect**: Meet like-minded people passionate about Open Source
+
+---
+
+## 🤝 របៀបក្នុងការចូលរួមអភិវឌ្ឍន៍ប្រព័ន្ធកូដបើកជំហ
+
+នេះគឺជាវិធីមួយចំនួនដែលអ្នកអាចជួយកែលម្អ CheckCle:
+
+- 🐞 **រាយការណ៍កំហុស** - រកឃើញកំហុសថ្មី? អនុញ្ញាតឱ្យយើងដឹងដោយបើកផងដោយបង្កើត [GitHub Issue](https://github.com/operacle/checkcle/issues).
+- 🌟 **ផ្តល់យោបល់** – មានគំនិតថ្មី?​ អនុញ្ញាតឱ្យយើងដឹងដោយបើកផងដោយបង្កើត [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue.
+- 🛠 **បញ្ជូនសំណើអភិវឌ្ឍន៍កូដ** – កែលម្អកូដ ជួសជុលកំហុស បន្ថែមមុខងារ ឬកែលម្អឯកសារ។
+- 📝 **ធ្វើអោយឯកសារប្រសើរឡើង** – សូម្បីតែការកែលម្អបន្តិចបន្តួចក៏អាចជួយបាន!
+- 🌍 **ផ្សព្វផ្សាយ** – ដាក់ផ្កាយ ⭐ repo ចែករំលែកវានៅលើសង្គមហើយអញ្ជើញអ្នកផ្សេងទៀតឱ្យចូលរួមអភិវឌ្ឍន៍!
+
+---
+
+## 🌍 រក្សាទំនាក់ទំនង
+- វ៉េបសាយ: [checkcle.io](https://checkcle.io)
+- ឯកសារ: [docs.checkcle.io](https://docs.checkcle.io)
+- ឃ្លាំងផ្ទុកកូដ: ⭐ [CheckCle](https://github.com/operacle/checkcle.git)
+- ទំនាក់ទំនងក្រុម: Engage via discussions and issues!
+- បណ្តាញសង្គម: Join our community [@discord](https://discord.gg/xs9gbubGwX)
+- X: [@tlengoss](https://x.com/tlengoss)
+
+## 📜 License
+
+CheckCle ត្រូវបានចេញផ្សាយក្រោមអាជ្ញាប័ណ្ណ MIT ។
+
+---
+## 👥 អ្នករួមចំណែក
+
+[![](https://contrib.rocks/image?repo=operacle/checkcle)](https://github.com/operacle/checkcle/graphs/contributors)
+
+
+## ស្ថានភាពផ្តាយ
+
+[![Star History Chart](https://api.star-history.com/svg?repos=operacle/checkcle&type=Date)](https://www.star-history.com/#operacle/checkcle&Date)
+
+កុំភ្លេចប្រើប្រាស់ឆេកខលសម្រាប់ការងាររបស់អ្នក! 🌐