EZSCALE/website
SHA256
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): reconcile against current reality

Browse Source 
Update codebase counts to live values, fix Gitea repo URL (was GitHub),
move multi-currency/KB from 'not yet implemented' to 'implemented',
refresh footer date.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Andrew Murray
2026-04-26 22:37:53 -04:00
parent 4a8a6f7564
commit ab3a195e85
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -3,7 +3,8 @@
Modern Laravel 12 billing and customer management platform replacing WHMCS for EZSCALE Hosting. Handles subscription billing, automated service provisioning, customer support, and admin analytics across VPS, Dedicated Server, Web Hosting, and Game Server products. Modern Laravel 12 billing and customer management platform replacing WHMCS for EZSCALE Hosting. Handles subscription billing, automated service provisioning, customer support, and admin analytics across VPS, Dedicated Server, Web Hosting, and Game Server products.
## Repository ## Repository
- **GitHub**: git@github.com:EZSCALE/accounting.git - **Gitea**: git@git.ezscale.cloud:EZSCALE/website.git
- **Issues**: https://git.ezscale.cloud/EZSCALE/website/issues
- **Branch**: `main` (direct commits) - **Branch**: `main` (direct commits)
## Documentation Files ## Documentation Files
@@ -69,14 +70,15 @@ Modern Laravel 12 billing and customer management platform replacing WHMCS for E
- Notification system (mail + database channels) for payment, subscription, provisioning events - Notification system (mail + database channels) for payment, subscription, provisioning events
- Command palette (Cmd+K) and dark/light theme toggle - Command palette (Cmd+K) and dark/light theme toggle
- Demo data seeder (300 customers, 500 subscriptions, 800 invoices) - Demo data seeder (300 customers, 500 subscriptions, 800 invoices)
- Multi-currency support (per-customer currency, exchange rates)
- Knowledge base with categories and articles
### Not Yet Implemented ### Not Yet Implemented
- Multi-currency support
- Bandwidth monitoring (ElastiFlow integration) and overage billing - Bandwidth monitoring (ElastiFlow integration) and overage billing
- Blog and knowledge base / FAQ - Blog
- WHMCS data migration (scripts in `scripts/whmcs-migrate/`, artisan commands not yet built) - WHMCS data migration (scripts in `scripts/whmcs-migrate/`, artisan commands not yet built)
- CI/CD pipeline (GitHub Actions) - CI/CD pipeline
- Staging environment - Staging environment
- Cloudflare Zero Trust configuration for admin panel - Cloudflare Zero Trust configuration for admin panel
@@ -110,14 +112,12 @@ Modern Laravel 12 billing and customer management platform replacing WHMCS for E
| Category | Count | | Category | Count |
|----------|-------| |----------|-------|
| Database migrations | 59 | | Database migrations | 94 |
| Eloquent models | 29 | | Eloquent models | 53 |
| Model factories | 24 | | Model factories | 42 |
| Vue pages | 85 | | Vue pages | 165 |
| Vue components | 26 | | Vue components | 54 |
| Test files | 43 | | Test files | 51 |
| Tests | ~497 |
| Assertions | ~2500 |
## Service Provisioning ## Service Provisioning
@@ -222,7 +222,7 @@ See **GETTING_STARTED.md** for the full development setup guide.
``` ```
website/ website/
├── app/ ├── app/
│ ├── Models/ # 29 Eloquent models │ ├── Models/ # 53 Eloquent models
│ ├── Http/Controllers/ # Account/, Admin/, Api/V1/ controllers │ ├── Http/Controllers/ # Account/, Admin/, Api/V1/ controllers
│ ├── Http/Resources/ # API Resources │ ├── Http/Resources/ # API Resources
│ ├── Services/Billing/ # Stripe, PayPal, Dunning services │ ├── Services/Billing/ # Stripe, PayPal, Dunning services
@@ -230,20 +230,20 @@ website/
│ ├── Listeners/ # Event handlers │ ├── Listeners/ # Event handlers
│ └── Console/Commands/ # RetryProvisioning, SyncStripePrices, etc. │ └── Console/Commands/ # RetryProvisioning, SyncStripePrices, etc.
├── database/ ├── database/
│ ├── migrations/ # 59 migrations │ ├── migrations/ # 94 migrations
│ ├── factories/ # 24 factories │ ├── factories/ # 24 factories
│ └── seeders/ # Roles, plans, admin, demo data │ └── seeders/ # Roles, plans, admin, demo data
├── resources/ ├── resources/
│ ├── ts/ # TypeScript source │ ├── ts/ # TypeScript source
│ │ ├── Pages/ # 85 Vue pages │ │ ├── Pages/ # 165 Vue pages
│ │ ├── Components/ # 26 Vue components │ │ ├── Components/ # 54 Vue components
│ │ ├── Layouts/ # Account, Admin, Auth, Marketing │ │ ├── Layouts/ # Account, Admin, Auth, Marketing
│ │ ├── stores/ # Pinia stores │ │ ├── stores/ # Pinia stores
│ │ ├── types/ # TypeScript interfaces │ │ ├── types/ # TypeScript interfaces
│ │ └── plugins/vuetify/ # Theme, defaults, icons │ │ └── plugins/vuetify/ # Theme, defaults, icons
│ └── styles/ # Custom EZSCALE design system (SCSS) │ └── styles/ # Custom EZSCALE design system (SCSS)
├── routes/ # web, account, admin, marketing, webhooks, api ├── routes/ # web, account, admin, marketing, webhooks, api
├── tests/ # 43 test files (~497 tests) ├── tests/ # 51 test files
└── scripts/whmcs-migrate/ # WHMCS migration scripts (WIP) └── scripts/whmcs-migrate/ # WHMCS migration scripts (WIP)
``` ```
@@ -254,5 +254,5 @@ Migration from WHMCS is planned for the launch phase. Migration scripts are in `
--- ---
**Status**: Active Development — Phases 1-5, 8-9 complete, Phase 10 in progress **Status**: Active Development — Phases 1-5, 8-9 complete, Phase 10 in progress
**Last Updated**: March 16, 2026 **Last Updated**: April 26, 2026
**Total Documentation**: 9 files, ~5900 lines of specifications **Total Documentation**: 9 files, ~5900 lines of specifications