docs: add comprehensive project documentation

- Add detailed project overview with 58+ applications - Create functional category organization (20 categories) - Add complete application inventory table with links - Document development workflow and directory structure - Add Cloudron packaging resources and project goals 💘 Generated with Crush Assisted-by: GLM-4.7 via Crush <crush@charm.land>
2026-02-04 07:58:24 -05:00
parent e2c8067ae5
commit 61225a20e5
1 changed files with 194 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,195 @@
-# TSYSDevStack-SupportStack-Cloudron
+# TSYS Cloudron Packaging Project

-Upstream applications packaged for cloudron 
+This project contains the upstream source code repositories for applications being packaged for Cloudron deployment as part of the TSYS Group Development Stack.
+
+## 🚀 Project Overview
+
+The Cloudron component focuses on packaging upstream free/libre/open applications for deployment onto Cloudron (TSYS Group's PaaS of choice). This is a massive undertaking involving **58+ applications** across **20 functional categories**.
+
+### 📊 Project Statistics
+
+- **Total Applications**: 58+
+- **Functional Categories**: 20
+- **Programming Languages**: 9+
+- **Project Timeline**: 48-hour delivery deadline
+- **Target Completion**: 2025-11-15
+
+## 📁 Functional Organization
+
+Applications are organized by function rather than programming language:
+
+| Functional Category | Description | App Count |
+|-------------------|-------------|------------|
+| **API-Gateway** | API management and gateway solutions | 2 |
+| **Automation** | Workflow automation and scripting tools | 4 |
+| **Business-Apps** | Enterprise business applications | 9 |
+| **Collaboration** | Team collaboration and communication | 2 |
+| **Communication** | Messaging and communication platforms | 2 |
+| **Data-Management** | Data processing and management tools | 2 |
+| **Development** | Development tools and platforms | 4 |
+| **DevOps-Tools** | DevOps and infrastructure tooling | 2 |
+| **Documentation-Tools** | Documentation and diagramming tools | 3 |
+| **Financial-Payments** | Payment processing and financial infrastructure | 1 |
+| **Financial-Trading** | Trading and financial algorithm platforms | 1 |
+| **Infrastructure** | Infrastructure and networking tools | 6 |
+| **Legal** | Legal and compliance applications | 1 |
+| **Low-Code** | Low-code and no-code platforms | 3 |
+| **Monitoring** | Monitoring and observability tools | 6 |
+| **Project-Management** | Project management solutions | 1 |
+| **Scientific-Computing** | Scientific and research computing | 2 |
+| **Security** | Security and cybersecurity tools | 5 |
+| **System-Administration** | System administration tools | 3 |
+
+## 📋 Application Inventory
+
+| Application Name | Repository | Description | Functional Category |
+|---|---|---|---|
+| [GoAlert](https://github.com/target/goalert) | [GitHub](https://github.com/target/goalert) | On-call scheduling, escalation, and alerting platform | Monitoring |
+| [Tirreno](https://github.com/tirrenotechnologies/tirreno) | [GitHub](https://github.com/tirrenotechnologies/tirreno) | Security and threat intelligence platform | Security |
+| [Runme](https://github.com/runmedev/runme) | [GitHub](https://github.com/runmedev/runme) | Execute your README.md as interactive scripts | Automation |
+| [DataHub](https://github.com/datahub-project/datahub) | [GitHub](https://github.com/datahub-project/datahub) | Modern data stack for end-to-end data management | Data-Management |
+| [Docassemble](https://github.com/jhpyle/docassemble) | [GitHub](https://github.com/jhpyle/docassemble) | Open-source expert system for guided interviews | Legal |
+| [Pimcore](https://github.com/pimcore/pimcore) | [GitHub](https://github.com/pimcore/pimcore) | Open-source digital experience platform | Business-Apps |
+| [Database-Gateway](https://github.com/kazhuravlev/database-gateway) | [GitHub](https://github.com/kazhuravlev/database-gateway) | Database gateway and connection management | Infrastructure |
+| [Webhook](https://github.com/adnanh/webhook) | [GitHub](https://github.com/adnanh/webhook) | Lightweight webhook receiver | API-Gateway |
+| [FX](https://github.com/metrue/fx) | [GitHub](https://github.com/metrue/fx) | Function as a Service platform | DevOps-Tools |
+| [Fonoster](https://github.com/fonoster/fonoster) | [GitHub](https://github.com/fonoster/fonoster) | Open-source CPaaS for communications | Communication |
+| [Rundeck](https://github.com/rundeck/rundeck) | [GitHub](https://github.com/rundeck/rundeck) | Job scheduling and automation platform | Automation |
+| [Hyperswitch](https://github.com/juspay/hyperswitch) | [GitHub](https://github.com/juspay/hyperswitch) | Open-source payment switch | Financial-Payments |
+| [PayrollEngine](https://github.com/Payroll-Engine/PayrollEngine) | [GitHub](https://github.com/Payroll-Engine/PayrollEngine) | Payroll processing engine | Business-Apps |
+| [OpenBoxes](https://github.com/openboxes/openboxes) | [GitHub](https://github.com/openboxes/openboxes) | Supply chain management for inventory | Business-Apps |
+| [Nautilus Trader](https://github.com/nautechsystems/nautilus_trader) | [GitHub](https://github.com/nautechsystems/nautilus_trader) | Algorithmic trading platform | Financial-Trading |
+| [APISIX](https://github.com/apache/apisix) | [GitHub](https://github.com/apache/apisix) | Cloud-native API gateway | API-Gateway |
+| [Grist Core](https://github.com/gristlabs/grist-core) | [GitHub](https://github.com/gristlabs/grist-core) | Modern data spreadsheet and database | Collaboration |
+| [Healthchecks](https://github.com/healthchecks/healthchecks) | [GitHub](https://github.com/healthchecks/healthchecks) | Cron job monitoring service | Monitoring |
+| [Fleet](https://github.com/fleetdm/fleet) | [GitHub](https://github.com/fleetdm/fleet) | Device management and monitoring | Monitoring |
+| [NetBox](https://github.com/netbox-community/netbox) | [GitHub](https://github.com/netbox-community/netbox) | IP address management (IPAM) and data center infrastructure management | Infrastructure |
+| [SeaTunnel](https://github.com/apache/seatunnel) | [GitHub](https://github.com/apache/seatunnel) | Data integration and streaming platform | Data-Management |
+| [Rathole](https://github.com/rapiz1/rathole) | [GitHub](https://github.com/rapiz1/rathole) | Lightweight and high-performance reverse proxy | Infrastructure |
+| [Easy-Gate](https://github.com/wiredlush/easy-gate) | [GitHub](https://github.com/wiredlush/easy-gate) | Gateway and proxy solution | Infrastructure |
+| [Huginn](https://github.com/huginn/huginn) | [GitHub](https://github.com/huginn/huginn) | Agents that do things for you automatically | Automation |
+| [ConsulDemocracy](https://github.com/consuldemocracy/consuldemocracy) | [GitHub](https://github.com/consuldemocracy/consuldemocracy) | Open-source citizen participation platform | Collaboration |
+| [BOINC](https://github.com/BOINC/boinc) | [GitHub](https://github.com/BOINC/boinc) | Open-source software for volunteer computing | Scientific-Computing |
+| [Slurm](https://github.com/SchedMD/slurm) | [GitHub](https://github.com/SchedMD/slurm) | Workload manager and job scheduling system | System-Administration |
+| [Gophish](https://github.com/gophish/gophish) | [GitHub](https://github.com/gophish/gophish) | Open-source phishing toolkit | Security |
+| [SniperPhish](https://github.com/GemGeorge/SniperPhish) | [GitHub](https://github.com/GemGeorge/SniperPhish) | Phishing campaign management platform | Security |
+| [InvenTree](https://github.com/inventree/InvenTree) | [GitHub](https://github.com/inventree/InvenTree) | Open-source inventory management system | Business-Apps |
+| [Mender](https://github.com/mendersoftware/mender) | [GitHub](https://github.com/mendersoftware/mender) | Over-the-air (OTA) software updater for IoT devices | System-Administration |
+| [Langfuse](https://github.com/langfuse/langfuse) | [GitHub](https://github.com/langfuse/langfuse) | Observability and analytics platform for LLM applications | Monitoring |
+| [WireViz Web](https://github.com/wireviz/wireviz-web) | [GitHub](https://github.com/wireviz/wireviz-web) | Cable and wiring harness visualization tool | Documentation-Tools |
+| [WireViz](https://github.com/wireviz/WireViz) | [GitHub](https://github.com/wireviz/WireViz) | Cable and wiring harness documentation tool | Documentation-Tools |
+| [KillBill](https://github.com/killbill/killbill) | [GitHub](https://github.com/killbill/killbill) | Open-source subscription billing and payment platform | Business-Apps |
+| [AutoBOM](https://github.com/opulo-inc/autobom) | [GitHub](https://github.com/opulo-inc/autobom) | Automatic bill of materials generation | Development |
+| [Midday](https://github.com/midday-ai/midday) | [GitHub](https://github.com/midday-ai/midday) | AI-powered business intelligence platform | Business-Apps |
+| [OpenBlocks](https://github.com/openblocks-dev/openblocks) | [GitHub](https://github.com/openblocks-dev/openblocks) | Low-code application development platform | Low-Code |
+| [Docker DrawIO](https://github.com/jgraph/docker-drawio) | [GitHub](https://github.com/jgraph/docker-drawio) | Dockerized version of Draw.io diagramming tool | Documentation-Tools |
+| [SigNoz](https://github.com/SigNoz/signoz) | [GitHub](https://github.com/SigNoz/signoz) | Open-source observability platform | Monitoring |
+| [Sentry](https://github.com/getsentry/sentry) | [GitHub](https://github.com/getsentry/sentry) | Error tracking and performance monitoring | Monitoring |
+| [ChirpStack](https://github.com/chirpstack/chirpstack) | [GitHub](https://github.com/chirpstack/chirpstack) | Open-source LoRaWAN network server | Infrastructure |
+| [eLabFTW](https://github.com/elabftw/elabftw) | [GitHub](https://github.com/elabftw/elabftw) | Electronic lab notebook for research teams | Business-Apps |
+| [PLMore](https://github.com/PLMore/PLMore) | [GitHub](https://github.com/PLMore/PLMore) | Business process management platform | Business-Apps |
+| [Jamovi](https://github.com/jamovi/jamovi) | [GitHub](https://github.com/jamovi/jamovi) | Statistical spreadsheet software | Scientific-Computing |
+| [Review Board](https://github.com/reviewboard/reviewboard) | [GitHub](https://github.com/reviewboard/reviewboard) | Code review and collaboration tool | Development |
+| [Core](https://github.com/Resgrid/Core) | [GitHub](https://github.com/Resgrid/Core) | Emergency management and incident response system | Project-Management |
+| [SDRangel](https://github.com/f4exb/sdrangel) | [GitHub](https://github.com/f4exb/sdrangel) | Software defined radio application | Infrastructure |
+| [No-Code Architects Toolkit](https://github.com/stephengpope/no-code-architects-toolkit) | [GitHub](https://github.com/stephengpope/no-code-architects-toolkit) | No-code development toolkit | Low-Code |
+| [Warp](https://github.com/sebo-b/warp) | [GitHub](https://github.com/sebo-b/warp) | Terminal and shell enhancement tool | Development |
+| [Windmill](https://github.com/windmill-labs/windmill) | [GitHub](https://github.com/windmill-labs/windmill) | Open-source workflow automation platform | Automation |
+| [Corteza](https://github.com/cortezaproject/corteza) | [GitHub](https://github.com/cortezaproject/corteza) | Open-source low-code platform | Low-Code |
+| [Security Awareness Training](https://github.com/security-companion/security-awareness-training) | [GitHub](https://github.com/security-companion/security-awareness-training) | Security awareness training platform | Security |
+| [Comply](https://github.com/strongdm/comply) | [GitHub](https://github.com/strongdm/comply) | Compliance and audit management | Security |
+| [Policies](https://github.com/todogroup/policies) | [GitHub](https://github.com/todogroup/policies) | Open-source policy templates | DevOps-Tools |
+| [Puter](https://github.com/HeyPuter/puter) | [GitHub](https://github.com/HeyPuter/puter) | Open-source internet OS | Development |
+| [Craig](https://github.com/CraigChat/craig) | [GitHub](https://github.com/CraigChat/craig) | Multi-track voice recorder for Discord | Communication |
+
+## 🛠️ Development Workflow
+
+### For New Contributors
+
+1. **Clone this repository**:
+   ```bash
+   git clone <repository-url>
+   cd TSYSDevStack/Platform/Cloudron
+   ```
+
+2. **Clone all upstream repositories**:
+   ```bash
+   ./clone-repos.sh
+   ```
+
+3. **Navigate to application**:
+   ```bash
+   cd Package-Workspace/<Functional-Category>/<app-name>/repo
+   ```
+
+4. **Create Cloudron package**:
+   - Create `Dockerfile`
+   - Create `CloudronManifest.json`
+   - Test with `cloudron build`
+
+### Directory Structure
+
+```
+Cloudron/
+├── README.md                    # This file
+├── GitUrlList.txt              # List of upstream repositories
+├── clone-repos.sh              # Script to clone all repositories
+├── AGENTS.md                   # AI agent context and guidelines
+├── .gitignore                  # Git ignore rules
+├── Package-Artifacts/          # Completed Cloudron packages
+└── Package-Workspace/         # Working directory
+    ├── API-Gateway/
+    ├── Automation/
+    ├── Business-Apps/
+    ├── Collaboration/
+    ├── Communication/
+    ├── Data-Management/
+    ├── Development/
+    ├── DevOps-Tools/
+    ├── Infrastructure/
+    ├── Legal/
+    ├── Low-Code/
+    ├── Monitoring/
+    ├── Project-Management/
+    ├── Scientific-Computing/
+    ├── Security/
+    └── System-Administration/
+        └── <app-name>/
+            └── repo/          # Cloned upstream repository
+```
+
+## 📚 Cloudron Packaging Resources
+
+- [Cloudron Packaging Tutorial](https://docs.cloudron.io/packaging/tutorial/)
+- [Cloudron Manifest Documentation](https://docs.cloudron.io/packaging/manifest/)
+- [Cloudron CLI Documentation](https://docs.cloudron.io/packaging/cli/)
+- [Existing Cloudron Packages](https://git.cloudron.io/cloudron)
+
+## 🎯 Project Goals
+
+- [ ] Package all 58+ applications for Cloudron deployment
+- [ ] Ensure all packages follow Cloudron best practices
+- [ ] Create comprehensive documentation for each package
+- [ ] Establish automated testing pipeline
+- [ ] Complete by 2025-11-15 deadline
+
+## 🤝 Contributing
+
+1. Fork this repository
+2. Create a feature branch
+3. Package your application
+4. Test thoroughly
+5. Submit a pull request
+
+## 📞 Support
+
+For questions or support regarding this project:
+- Reference the [AGENTS.md](./AGENTS.md) file for AI agent context
+- Check existing Cloudron documentation
+- Review existing packages for patterns
+
+---
+
+**Project Lead**: Charles N Wyble (@REachableCEO)  
+**Last Updated**: 2025-11-13  
+**Version**: 1.0.0