@cloudgrid-io/mcp 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/corpus/capability-map.md +81 -7
- package/src/corpus/templates/_cloudgrid.yaml.reference +228 -0
- package/src/corpus/templates/admin-dashboard/cloudgrid.yaml +226 -8
- package/src/corpus/templates/admin-dashboard/index.md +3 -0
- package/src/corpus/templates/ai-app/cloudgrid.yaml +225 -11
- package/src/corpus/templates/ai-app/index.md +3 -11
- package/src/corpus/templates/ai-knowledge-base/AGENTS.md +254 -0
- package/src/corpus/templates/ai-knowledge-base/README.md +28 -0
- package/src/corpus/templates/ai-knowledge-base/cloudgrid.yaml +238 -0
- package/src/corpus/templates/ai-knowledge-base/index.md +81 -0
- package/src/corpus/templates/analytics-dashboard/README.md +85 -0
- package/src/corpus/templates/analytics-dashboard/cloudgrid.yaml +232 -0
- package/src/corpus/templates/analytics-dashboard/index.md +316 -0
- package/src/corpus/templates/analytics-dashboard/services/web/app/api/events/route.js +60 -0
- package/src/corpus/templates/analytics-dashboard/services/web/app/event-form.js +100 -0
- package/src/corpus/templates/analytics-dashboard/services/web/app/layout.js +41 -0
- package/src/corpus/templates/analytics-dashboard/services/web/app/page.js +54 -0
- package/src/corpus/templates/analytics-dashboard/services/web/lib/db.js +32 -0
- package/src/corpus/templates/analytics-dashboard/services/web/package.json +16 -0
- package/src/corpus/templates/api-dashboard/README.md +84 -0
- package/src/corpus/templates/api-dashboard/cloudgrid.yaml +233 -0
- package/src/corpus/templates/api-dashboard/index.md +310 -0
- package/src/corpus/templates/api-dashboard/services/web/app/api/requests/route.js +62 -0
- package/src/corpus/templates/api-dashboard/services/web/app/dashboard.js +156 -0
- package/src/corpus/templates/api-dashboard/services/web/app/layout.js +42 -0
- package/src/corpus/templates/api-dashboard/services/web/app/page.js +39 -0
- package/src/corpus/templates/api-dashboard/services/web/lib/db.js +32 -0
- package/src/corpus/templates/api-dashboard/services/web/package.json +16 -0
- package/src/corpus/templates/api-docs/cloudgrid.yaml +222 -4
- package/src/corpus/templates/api-docs/index.md +3 -5
- package/src/corpus/templates/api-service/cloudgrid.yaml +224 -9
- package/src/corpus/templates/api-service/index.md +3 -11
- package/src/corpus/templates/app-with-data/cloudgrid.yaml +226 -8
- package/src/corpus/templates/app-with-data/index.md +3 -8
- package/src/corpus/templates/appointment-booking/AGENTS.md +223 -0
- package/src/corpus/templates/appointment-booking/README.md +16 -0
- package/src/corpus/templates/appointment-booking/cloudgrid.yaml +250 -0
- package/src/corpus/templates/appointment-booking/index.md +72 -0
- package/src/corpus/templates/approval-workflow/AGENTS.md +170 -0
- package/src/corpus/templates/approval-workflow/README.md +12 -0
- package/src/corpus/templates/approval-workflow/cloudgrid.yaml +237 -0
- package/src/corpus/templates/approval-workflow/index.md +58 -0
- package/src/corpus/templates/billing-dashboard/AGENTS.md +199 -0
- package/src/corpus/templates/billing-dashboard/README.md +18 -0
- package/src/corpus/templates/billing-dashboard/cloudgrid.yaml +235 -0
- package/src/corpus/templates/billing-dashboard/index.md +87 -0
- package/src/corpus/templates/blog-cms/README.md +94 -0
- package/src/corpus/templates/blog-cms/cloudgrid.yaml +233 -0
- package/src/corpus/templates/blog-cms/index.md +358 -0
- package/src/corpus/templates/blog-cms/services/web/app/admin/admin-editor.js +133 -0
- package/src/corpus/templates/blog-cms/services/web/app/admin/page.js +33 -0
- package/src/corpus/templates/blog-cms/services/web/app/api/posts/route.js +84 -0
- package/src/corpus/templates/blog-cms/services/web/app/layout.js +47 -0
- package/src/corpus/templates/blog-cms/services/web/app/page.js +56 -0
- package/src/corpus/templates/blog-cms/services/web/app/posts/[slug]/page.js +45 -0
- package/src/corpus/templates/blog-cms/services/web/lib/db.js +32 -0
- package/src/corpus/templates/blog-cms/services/web/package.json +16 -0
- package/src/corpus/templates/booking-system/AGENTS.md +189 -0
- package/src/corpus/templates/booking-system/README.md +17 -0
- package/src/corpus/templates/booking-system/cloudgrid.yaml +248 -0
- package/src/corpus/templates/booking-system/index.md +86 -0
- package/src/corpus/templates/calendar-scheduler/AGENTS.md +226 -0
- package/src/corpus/templates/calendar-scheduler/README.md +25 -0
- package/src/corpus/templates/calendar-scheduler/cloudgrid.yaml +259 -0
- package/src/corpus/templates/calendar-scheduler/index.md +85 -0
- package/src/corpus/templates/changelog/cloudgrid.yaml +222 -4
- package/src/corpus/templates/changelog/index.md +3 -5
- package/src/corpus/templates/company-website/README.md +54 -0
- package/src/corpus/templates/company-website/cloudgrid.yaml +233 -0
- package/src/corpus/templates/company-website/index.html +309 -0
- package/src/corpus/templates/company-website/index.md +29 -0
- package/src/corpus/templates/course-platform/AGENTS.md +161 -0
- package/src/corpus/templates/course-platform/README.md +26 -0
- package/src/corpus/templates/course-platform/cloudgrid.yaml +237 -0
- package/src/corpus/templates/course-platform/index.md +70 -0
- package/src/corpus/templates/crm/cloudgrid.yaml +226 -8
- package/src/corpus/templates/crm/index.md +3 -0
- package/src/corpus/templates/dashboard/cloudgrid.yaml +228 -4
- package/src/corpus/templates/dashboard/index.md +3 -5
- package/src/corpus/templates/deck/cloudgrid.yaml +228 -4
- package/src/corpus/templates/deck/index.md +3 -5
- package/src/corpus/templates/directory/README.md +75 -0
- package/src/corpus/templates/directory/cloudgrid.yaml +233 -0
- package/src/corpus/templates/directory/index.md +334 -0
- package/src/corpus/templates/directory/services/web/app/api/entries/route.js +63 -0
- package/src/corpus/templates/directory/services/web/app/directory-list.js +146 -0
- package/src/corpus/templates/directory/services/web/app/layout.js +44 -0
- package/src/corpus/templates/directory/services/web/app/page.js +38 -0
- package/src/corpus/templates/directory/services/web/lib/db.js +32 -0
- package/src/corpus/templates/directory/services/web/package.json +16 -0
- package/src/corpus/templates/docs-site/cloudgrid.yaml +222 -4
- package/src/corpus/templates/docs-site/index.md +3 -5
- package/src/corpus/templates/erp/AGENTS.md +116 -0
- package/src/corpus/templates/erp/README.md +17 -0
- package/src/corpus/templates/erp/cloudgrid.yaml +235 -0
- package/src/corpus/templates/erp/index.md +81 -0
- package/src/corpus/templates/event-board/README.md +74 -0
- package/src/corpus/templates/event-board/cloudgrid.yaml +233 -0
- package/src/corpus/templates/event-board/index.md +299 -0
- package/src/corpus/templates/event-board/services/web/app/api/events/route.js +61 -0
- package/src/corpus/templates/event-board/services/web/app/event-form.js +118 -0
- package/src/corpus/templates/event-board/services/web/app/layout.js +39 -0
- package/src/corpus/templates/event-board/services/web/app/page.js +34 -0
- package/src/corpus/templates/event-board/services/web/lib/db.js +32 -0
- package/src/corpus/templates/event-board/services/web/package.json +16 -0
- package/src/corpus/templates/expense-tracker/README.md +76 -0
- package/src/corpus/templates/expense-tracker/cloudgrid.yaml +233 -0
- package/src/corpus/templates/expense-tracker/index.md +305 -0
- package/src/corpus/templates/expense-tracker/services/web/app/api/expenses/route.js +61 -0
- package/src/corpus/templates/expense-tracker/services/web/app/expense-form.js +145 -0
- package/src/corpus/templates/expense-tracker/services/web/app/layout.js +42 -0
- package/src/corpus/templates/expense-tracker/services/web/app/page.js +34 -0
- package/src/corpus/templates/expense-tracker/services/web/lib/db.js +32 -0
- package/src/corpus/templates/expense-tracker/services/web/package.json +16 -0
- package/src/corpus/templates/feature-request-board/README.md +87 -0
- package/src/corpus/templates/feature-request-board/cloudgrid.yaml +233 -0
- package/src/corpus/templates/feature-request-board/index.md +317 -0
- package/src/corpus/templates/feature-request-board/services/web/app/api/requests/route.js +92 -0
- package/src/corpus/templates/feature-request-board/services/web/app/board.js +91 -0
- package/src/corpus/templates/feature-request-board/services/web/app/layout.js +43 -0
- package/src/corpus/templates/feature-request-board/services/web/app/page.js +35 -0
- package/src/corpus/templates/feature-request-board/services/web/lib/db.js +32 -0
- package/src/corpus/templates/feature-request-board/services/web/package.json +16 -0
- package/src/corpus/templates/financial-dashboard/README.md +80 -0
- package/src/corpus/templates/financial-dashboard/cloudgrid.yaml +233 -0
- package/src/corpus/templates/financial-dashboard/index.md +326 -0
- package/src/corpus/templates/financial-dashboard/services/web/app/api/entries/route.js +63 -0
- package/src/corpus/templates/financial-dashboard/services/web/app/entry-board.js +130 -0
- package/src/corpus/templates/financial-dashboard/services/web/app/layout.js +46 -0
- package/src/corpus/templates/financial-dashboard/services/web/app/page.js +31 -0
- package/src/corpus/templates/financial-dashboard/services/web/lib/db.js +32 -0
- package/src/corpus/templates/financial-dashboard/services/web/package.json +16 -0
- package/src/corpus/templates/forum/AGENTS.md +196 -0
- package/src/corpus/templates/forum/README.md +12 -0
- package/src/corpus/templates/forum/cloudgrid.yaml +237 -0
- package/src/corpus/templates/forum/index.md +66 -0
- package/src/corpus/templates/hr-portal/AGENTS.md +174 -0
- package/src/corpus/templates/hr-portal/README.md +14 -0
- package/src/corpus/templates/hr-portal/cloudgrid.yaml +237 -0
- package/src/corpus/templates/hr-portal/index.md +56 -0
- package/src/corpus/templates/internal-tools-portal/AGENTS.md +201 -0
- package/src/corpus/templates/internal-tools-portal/README.md +17 -0
- package/src/corpus/templates/internal-tools-portal/cloudgrid.yaml +237 -0
- package/src/corpus/templates/internal-tools-portal/index.md +62 -0
- package/src/corpus/templates/inventory/README.md +71 -0
- package/src/corpus/templates/inventory/cloudgrid.yaml +233 -0
- package/src/corpus/templates/inventory/index.md +68 -0
- package/src/corpus/templates/inventory/services/web/app/api/items/route.js +88 -0
- package/src/corpus/templates/inventory/services/web/app/inventory-manager.js +101 -0
- package/src/corpus/templates/inventory/services/web/app/layout.js +36 -0
- package/src/corpus/templates/inventory/services/web/app/page.js +37 -0
- package/src/corpus/templates/inventory/services/web/lib/db.js +32 -0
- package/src/corpus/templates/inventory/services/web/package.json +16 -0
- package/src/corpus/templates/invoice/README.md +71 -0
- package/src/corpus/templates/invoice/cloudgrid.yaml +233 -0
- package/src/corpus/templates/invoice/index.md +68 -0
- package/src/corpus/templates/invoice/services/web/app/api/invoices/route.js +82 -0
- package/src/corpus/templates/invoice/services/web/app/invoice-manager.js +101 -0
- package/src/corpus/templates/invoice/services/web/app/layout.js +35 -0
- package/src/corpus/templates/invoice/services/web/app/page.js +34 -0
- package/src/corpus/templates/invoice/services/web/lib/db.js +32 -0
- package/src/corpus/templates/invoice/services/web/package.json +16 -0
- package/src/corpus/templates/job-board/README.md +71 -0
- package/src/corpus/templates/job-board/cloudgrid.yaml +233 -0
- package/src/corpus/templates/job-board/index.md +68 -0
- package/src/corpus/templates/job-board/services/web/app/api/jobs/route.js +66 -0
- package/src/corpus/templates/job-board/services/web/app/job-board.js +73 -0
- package/src/corpus/templates/job-board/services/web/app/layout.js +35 -0
- package/src/corpus/templates/job-board/services/web/app/page.js +32 -0
- package/src/corpus/templates/job-board/services/web/lib/db.js +32 -0
- package/src/corpus/templates/job-board/services/web/package.json +16 -0
- package/src/corpus/templates/kanban/cloudgrid.yaml +226 -8
- package/src/corpus/templates/kanban/index.md +3 -0
- package/src/corpus/templates/landing-page/cloudgrid.yaml +228 -4
- package/src/corpus/templates/landing-page/index.md +3 -5
- package/src/corpus/templates/lms/AGENTS.md +193 -0
- package/src/corpus/templates/lms/README.md +27 -0
- package/src/corpus/templates/lms/cloudgrid.yaml +237 -0
- package/src/corpus/templates/lms/index.md +79 -0
- package/src/corpus/templates/marketplace/AGENTS.md +208 -0
- package/src/corpus/templates/marketplace/README.md +22 -0
- package/src/corpus/templates/marketplace/cloudgrid.yaml +233 -0
- package/src/corpus/templates/marketplace/index.md +76 -0
- package/src/corpus/templates/membership-site/AGENTS.md +160 -0
- package/src/corpus/templates/membership-site/README.md +18 -0
- package/src/corpus/templates/membership-site/cloudgrid.yaml +236 -0
- package/src/corpus/templates/membership-site/index.md +66 -0
- package/src/corpus/templates/monitoring-dashboard/README.md +84 -0
- package/src/corpus/templates/monitoring-dashboard/cloudgrid.yaml +233 -0
- package/src/corpus/templates/monitoring-dashboard/index.md +328 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/app/api/checks/route.js +76 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/app/check-form.js +124 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/app/layout.js +44 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/app/page.js +49 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/lib/db.js +32 -0
- package/src/corpus/templates/monitoring-dashboard/services/web/package.json +16 -0
- package/src/corpus/templates/online-store/AGENTS.md +153 -0
- package/src/corpus/templates/online-store/README.md +16 -0
- package/src/corpus/templates/online-store/cloudgrid.yaml +234 -0
- package/src/corpus/templates/online-store/index.md +81 -0
- package/src/corpus/templates/portfolio/cloudgrid.yaml +222 -4
- package/src/corpus/templates/portfolio/index.md +3 -5
- package/src/corpus/templates/product-catalog/README.md +74 -0
- package/src/corpus/templates/product-catalog/cloudgrid.yaml +232 -0
- package/src/corpus/templates/product-catalog/index.md +330 -0
- package/src/corpus/templates/product-catalog/services/web/app/api/products/route.js +69 -0
- package/src/corpus/templates/product-catalog/services/web/app/catalog.js +153 -0
- package/src/corpus/templates/product-catalog/services/web/app/layout.js +49 -0
- package/src/corpus/templates/product-catalog/services/web/app/page.js +36 -0
- package/src/corpus/templates/product-catalog/services/web/lib/db.js +32 -0
- package/src/corpus/templates/product-catalog/services/web/package.json +16 -0
- package/src/corpus/templates/product-launch/README.md +46 -0
- package/src/corpus/templates/product-launch/cloudgrid.yaml +234 -0
- package/src/corpus/templates/product-launch/index.html +320 -0
- package/src/corpus/templates/product-launch/index.md +34 -0
- package/src/corpus/templates/project-management/README.md +83 -0
- package/src/corpus/templates/project-management/cloudgrid.yaml +233 -0
- package/src/corpus/templates/project-management/index.md +346 -0
- package/src/corpus/templates/project-management/services/web/app/api/projects/route.js +48 -0
- package/src/corpus/templates/project-management/services/web/app/api/tasks/route.js +85 -0
- package/src/corpus/templates/project-management/services/web/app/board.js +182 -0
- package/src/corpus/templates/project-management/services/web/app/layout.js +45 -0
- package/src/corpus/templates/project-management/services/web/app/page.js +49 -0
- package/src/corpus/templates/project-management/services/web/lib/db.js +32 -0
- package/src/corpus/templates/project-management/services/web/package.json +16 -0
- package/src/corpus/templates/property-listings/README.md +76 -0
- package/src/corpus/templates/property-listings/cloudgrid.yaml +233 -0
- package/src/corpus/templates/property-listings/index.md +335 -0
- package/src/corpus/templates/property-listings/services/web/app/api/properties/route.js +73 -0
- package/src/corpus/templates/property-listings/services/web/app/layout.js +45 -0
- package/src/corpus/templates/property-listings/services/web/app/listings.js +152 -0
- package/src/corpus/templates/property-listings/services/web/app/page.js +53 -0
- package/src/corpus/templates/property-listings/services/web/lib/db.js +32 -0
- package/src/corpus/templates/property-listings/services/web/package.json +16 -0
- package/src/corpus/templates/quiz-platform/README.md +84 -0
- package/src/corpus/templates/quiz-platform/cloudgrid.yaml +233 -0
- package/src/corpus/templates/quiz-platform/index.md +313 -0
- package/src/corpus/templates/quiz-platform/services/web/app/api/questions/route.js +69 -0
- package/src/corpus/templates/quiz-platform/services/web/app/layout.js +47 -0
- package/src/corpus/templates/quiz-platform/services/web/app/page.js +37 -0
- package/src/corpus/templates/quiz-platform/services/web/app/quiz.js +188 -0
- package/src/corpus/templates/quiz-platform/services/web/lib/db.js +32 -0
- package/src/corpus/templates/quiz-platform/services/web/package.json +16 -0
- package/src/corpus/templates/report/cloudgrid.yaml +228 -4
- package/src/corpus/templates/report/index.md +3 -5
- package/src/corpus/templates/restaurant-reservations/AGENTS.md +258 -0
- package/src/corpus/templates/restaurant-reservations/README.md +17 -0
- package/src/corpus/templates/restaurant-reservations/cloudgrid.yaml +258 -0
- package/src/corpus/templates/restaurant-reservations/index.md +62 -0
- package/src/corpus/templates/revenue-dashboard/README.md +75 -0
- package/src/corpus/templates/revenue-dashboard/cloudgrid.yaml +233 -0
- package/src/corpus/templates/revenue-dashboard/index.md +307 -0
- package/src/corpus/templates/revenue-dashboard/services/web/app/api/sales/route.js +60 -0
- package/src/corpus/templates/revenue-dashboard/services/web/app/layout.js +40 -0
- package/src/corpus/templates/revenue-dashboard/services/web/app/page.js +87 -0
- package/src/corpus/templates/revenue-dashboard/services/web/app/sale-form.js +63 -0
- package/src/corpus/templates/revenue-dashboard/services/web/lib/db.js +32 -0
- package/src/corpus/templates/revenue-dashboard/services/web/package.json +16 -0
- package/src/corpus/templates/saas-marketing/cloudgrid.yaml +222 -4
- package/src/corpus/templates/saas-marketing/index.md +3 -5
- package/src/corpus/templates/semantic-search/AGENTS.md +192 -0
- package/src/corpus/templates/semantic-search/README.md +74 -0
- package/src/corpus/templates/semantic-search/cloudgrid.yaml +217 -0
- package/src/corpus/templates/semantic-search/index.md +97 -0
- package/src/corpus/templates/semantic-search/services/backend/requirements.txt +7 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/__init__.py +0 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/answer.py +90 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/auth.py +65 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/config.py +110 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/db.py +89 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/embeddings.py +44 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/indexing.py +222 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/main.py +259 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/search.py +222 -0
- package/src/corpus/templates/semantic-search/services/backend/src/app/source.py +259 -0
- package/src/corpus/templates/semantic-search/services/backend/src/main.py +12 -0
- package/src/corpus/templates/semantic-search/services/web/index.html +12 -0
- package/src/corpus/templates/semantic-search/services/web/package-lock.json +1680 -0
- package/src/corpus/templates/semantic-search/services/web/package.json +19 -0
- package/src/corpus/templates/semantic-search/services/web/src/App.jsx +55 -0
- package/src/corpus/templates/semantic-search/services/web/src/api.js +125 -0
- package/src/corpus/templates/semantic-search/services/web/src/components/Dashboard.jsx +61 -0
- package/src/corpus/templates/semantic-search/services/web/src/components/ManagerLogin.jsx +39 -0
- package/src/corpus/templates/semantic-search/services/web/src/components/SearchView.jsx +166 -0
- package/src/corpus/templates/semantic-search/services/web/src/components/Settings.jsx +148 -0
- package/src/corpus/templates/semantic-search/services/web/src/main.jsx +10 -0
- package/src/corpus/templates/semantic-search/services/web/src/styles.css +78 -0
- package/src/corpus/templates/semantic-search/services/web/vite.config.js +10 -0
- package/src/corpus/templates/status-page/cloudgrid.yaml +222 -4
- package/src/corpus/templates/status-page/index.md +3 -5
- package/src/corpus/templates/subscription-management/AGENTS.md +191 -0
- package/src/corpus/templates/subscription-management/README.md +21 -0
- package/src/corpus/templates/subscription-management/cloudgrid.yaml +236 -0
- package/src/corpus/templates/subscription-management/index.md +73 -0
- package/src/corpus/templates/task-manager/cloudgrid.yaml +226 -8
- package/src/corpus/templates/task-manager/index.md +3 -0
- package/src/corpus/templates/ticket-system/README.md +71 -0
- package/src/corpus/templates/ticket-system/cloudgrid.yaml +233 -0
- package/src/corpus/templates/ticket-system/index.md +68 -0
- package/src/corpus/templates/ticket-system/services/web/app/api/tickets/route.js +81 -0
- package/src/corpus/templates/ticket-system/services/web/app/layout.js +36 -0
- package/src/corpus/templates/ticket-system/services/web/app/page.js +35 -0
- package/src/corpus/templates/ticket-system/services/web/app/ticket-queue.js +112 -0
- package/src/corpus/templates/ticket-system/services/web/lib/db.js +32 -0
- package/src/corpus/templates/ticket-system/services/web/package.json +16 -0
- package/src/corpus/templates/time-tracking/README.md +81 -0
- package/src/corpus/templates/time-tracking/cloudgrid.yaml +233 -0
- package/src/corpus/templates/time-tracking/index.md +298 -0
- package/src/corpus/templates/time-tracking/services/web/app/api/entries/route.js +66 -0
- package/src/corpus/templates/time-tracking/services/web/app/entry-form.js +106 -0
- package/src/corpus/templates/time-tracking/services/web/app/layout.js +39 -0
- package/src/corpus/templates/time-tracking/services/web/app/page.js +30 -0
- package/src/corpus/templates/time-tracking/services/web/lib/db.js +32 -0
- package/src/corpus/templates/time-tracking/services/web/package.json +16 -0
- package/src/corpus/templates/travel-booking/AGENTS.md +207 -0
- package/src/corpus/templates/travel-booking/README.md +17 -0
- package/src/corpus/templates/travel-booking/cloudgrid.yaml +249 -0
- package/src/corpus/templates/travel-booking/index.md +88 -0
- package/src/corpus/templates/waitlist/cloudgrid.yaml +222 -4
- package/src/corpus/templates/waitlist/index.md +3 -5
- package/src/corpus/templates/web-app/cloudgrid.yaml +228 -4
- package/src/corpus/templates/web-app/index.md +3 -5
- package/src/corpus/workflows/ai-knowledge-base.md +137 -0
- package/src/corpus/workflows/analytics-dashboard.md +104 -0
- package/src/corpus/workflows/api-dashboard.md +102 -0
- package/src/corpus/workflows/appointment-booking.md +143 -0
- package/src/corpus/workflows/approval-workflow.md +124 -0
- package/src/corpus/workflows/billing-dashboard.md +120 -0
- package/src/corpus/workflows/blog-cms.md +104 -0
- package/src/corpus/workflows/booking-system.md +116 -0
- package/src/corpus/workflows/calendar-scheduler.md +134 -0
- package/src/corpus/workflows/company-website.md +46 -0
- package/src/corpus/workflows/course-platform.md +126 -0
- package/src/corpus/workflows/directory.md +101 -0
- package/src/corpus/workflows/erp.md +125 -0
- package/src/corpus/workflows/event-board.md +102 -0
- package/src/corpus/workflows/expense-tracker.md +102 -0
- package/src/corpus/workflows/feature-request-board.md +105 -0
- package/src/corpus/workflows/financial-dashboard.md +103 -0
- package/src/corpus/workflows/forum.md +128 -0
- package/src/corpus/workflows/hr-portal.md +115 -0
- package/src/corpus/workflows/internal-tools-portal.md +125 -0
- package/src/corpus/workflows/inventory.md +101 -0
- package/src/corpus/workflows/invoice.md +101 -0
- package/src/corpus/workflows/job-board.md +101 -0
- package/src/corpus/workflows/lms.md +113 -0
- package/src/corpus/workflows/marketplace.md +123 -0
- package/src/corpus/workflows/membership-site.md +128 -0
- package/src/corpus/workflows/monitoring-dashboard.md +104 -0
- package/src/corpus/workflows/online-store.md +114 -0
- package/src/corpus/workflows/product-catalog.md +105 -0
- package/src/corpus/workflows/product-launch.md +43 -0
- package/src/corpus/workflows/project-management.md +106 -0
- package/src/corpus/workflows/property-listings.md +101 -0
- package/src/corpus/workflows/quiz-platform.md +105 -0
- package/src/corpus/workflows/restaurant-reservations.md +123 -0
- package/src/corpus/workflows/revenue-dashboard.md +102 -0
- package/src/corpus/workflows/semantic-search.md +133 -0
- package/src/corpus/workflows/subscription-management.md +141 -0
- package/src/corpus/workflows/ticket-system.md +101 -0
- package/src/corpus/workflows/time-tracking.md +104 -0
- package/src/corpus/workflows/travel-booking.md +115 -0
- package/src/tools.js +73 -12
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
# ============================================================================
|
|
2
|
+
# cloudgrid.yaml — Complete Example
|
|
3
|
+
# ============================================================================
|
|
4
|
+
#
|
|
5
|
+
# This file shows EVERY field the platform supports, with comments explaining
|
|
6
|
+
# each one. It is a reference — no real project would use all of these at once.
|
|
7
|
+
#
|
|
8
|
+
# STANDARD: every CloudGrid template ships its cloudgrid.yaml in THIS full form.
|
|
9
|
+
# Uncomment ONLY the fields the archetype needs (always: name + services; plus
|
|
10
|
+
# needs: for runtime apps). Leave everything else commented. Comments are
|
|
11
|
+
# ignored by the parser, so the file deploys to exactly the active fields.
|
|
12
|
+
#
|
|
13
|
+
# Only two fields are required: name and services. Everything else is optional.
|
|
14
|
+
# Full docs: docs/cloudgrid-yaml-reference.md
|
|
15
|
+
# ============================================================================
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
# ─── IDENTITY ───────────────────────────────────────────────────────────────
|
|
19
|
+
|
|
20
|
+
# Entity slug (REQUIRED). 2-42 chars, lowercase alphanumeric + hyphens.
|
|
21
|
+
# Must start and end with a letter or digit.
|
|
22
|
+
# Becomes part of your public URL: <name>-<4hex>.<org>.cloudgrid.io
|
|
23
|
+
name: booking-system
|
|
24
|
+
|
|
25
|
+
# One-line summary. Max 280 chars. If omitted, Grid Brain auto-generates one.
|
|
26
|
+
# description: Order processing API for the e-commerce platform
|
|
27
|
+
|
|
28
|
+
# Single emoji or short text shown as the entity icon. Max 64 chars.
|
|
29
|
+
# icon: "📦"
|
|
30
|
+
|
|
31
|
+
# Entity type: 'app' (default) or 'agent'. An agent is an app with an agent: block.
|
|
32
|
+
# kind: app
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
# ─── NETWORKING ─────────────────────────────────────────────────────────────
|
|
36
|
+
|
|
37
|
+
# Whether this entity serves public HTTP traffic.
|
|
38
|
+
# true = public URL + Ingress (default). false = internal only.
|
|
39
|
+
# expose: true
|
|
40
|
+
|
|
41
|
+
# Additional domain names this entity serves on (the platform URL is always active).
|
|
42
|
+
# custom_domains:
|
|
43
|
+
# - orders.example.com
|
|
44
|
+
# - shop.example.com
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
# ─── HEALTH PROBE (entity-level override) ──────────────────────────────────
|
|
48
|
+
|
|
49
|
+
# Override the default health check for the entire entity.
|
|
50
|
+
# probe:
|
|
51
|
+
# path: /healthz # HTTP path to probe (default: /).
|
|
52
|
+
# expected: "<500" # '<500' (default), '200', '2xx'.
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
# ─── DEPLOY NOTIFICATIONS ──────────────────────────────────────────────────
|
|
56
|
+
|
|
57
|
+
# Slack notification to the org's default channel on deploy failure.
|
|
58
|
+
# true = notify (default), false = silent.
|
|
59
|
+
# notify: true
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
# ─── SCALING ────────────────────────────────────────────────────────────────
|
|
63
|
+
|
|
64
|
+
# Replica scaling intent.
|
|
65
|
+
# 'auto' — platform decides from the grid tier (default).
|
|
66
|
+
# 'alert' — single-replica, emit a SPOF warning at plug time.
|
|
67
|
+
# 1-10 — explicit replica count, clamped to the grid max.
|
|
68
|
+
# scale: auto
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
# ─── INFRASTRUCTURE NEEDS ──────────────────────────────────────────────────
|
|
72
|
+
#
|
|
73
|
+
# Declare infrastructure; the platform provisions it and injects connection
|
|
74
|
+
# details as env vars. Nine needs: database, cache, kv, queue, pubsub, vector,
|
|
75
|
+
# object_storage, disk, ai. Simplest form is `true`.
|
|
76
|
+
#
|
|
77
|
+
# needs:
|
|
78
|
+
# # database — MongoDB. Injects DATABASE_MONGODB_URL (+ legacy MONGODB_URL).
|
|
79
|
+
# # true | pool | dedicated | { tier: external, secret: MY_DB }
|
|
80
|
+
# database: true
|
|
81
|
+
# # cache — Redis, LRU eviction (derived data). Injects CACHE_REDIS_URL (+ REDIS_URL).
|
|
82
|
+
# # true | redis | { engine: external, secret: MY_REDIS_URL }
|
|
83
|
+
# cache: true
|
|
84
|
+
# # kv — Redis, no eviction (durable: flags, idempotency). Injects KV_REDIS_URL.
|
|
85
|
+
# kv: true
|
|
86
|
+
# # queue — Redis job-queue substrate (BullMQ). Injects QUEUE_REDIS_URL.
|
|
87
|
+
# queue: true
|
|
88
|
+
# # pubsub — Redis broadcast pub/sub. Injects PUBSUB_REDIS_URL.
|
|
89
|
+
# pubsub: true
|
|
90
|
+
# # vector — pgvector on Postgres. Injects VECTOR_PGVECTOR_URL (+ PGVECTOR_URL).
|
|
91
|
+
# # true | pgvector | { engine: pgvector, dim: 1536 }
|
|
92
|
+
# vector: pgvector
|
|
93
|
+
# # object_storage — GCS bucket. Injects OBJECT_STORAGE_GCS_BUCKET, _GCS_REGION.
|
|
94
|
+
# # true | { size: 10Gi }
|
|
95
|
+
# object_storage: true
|
|
96
|
+
# # disk — persistent FS mount (PVC). Injects DISK_PATH. Pins to 1 replica.
|
|
97
|
+
# # true | { size: 1Gi, mount: /var/data } (forbidden: /proc /sys /dev)
|
|
98
|
+
# disk: true
|
|
99
|
+
# # ai — AI Gateway via @cloudgrid-io/ai. Injects AI_GATEWAY_URL. true | false.
|
|
100
|
+
# ai: true
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
# ─── INTER-ENTITY COMMUNICATION ────────────────────────────────────────────
|
|
104
|
+
|
|
105
|
+
# Entities this app calls (outbound). Service-account token injected per pair.
|
|
106
|
+
# calls:
|
|
107
|
+
# - org:atomic/billing-api
|
|
108
|
+
|
|
109
|
+
# Inbound caller policy — who can call YOUR entity.
|
|
110
|
+
# callers:
|
|
111
|
+
# policy: auto # 'auto' | 'manual' (default).
|
|
112
|
+
# scope: org # 'org' (default) | 'space' | 'explicit'.
|
|
113
|
+
# fallback: deny # 'deny' (default) | 'warn'.
|
|
114
|
+
# # allowed_apps: # required only when scope: explicit
|
|
115
|
+
# # - org:atomic/frontend
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
# ─── VAULT ──────────────────────────────────────────────────────────────────
|
|
119
|
+
#
|
|
120
|
+
# Map org vault items to env vars. Keys UPPER_SNAKE_CASE; values = vault item keys.
|
|
121
|
+
# A booking system typically needs payment + auth provider secrets. These are the
|
|
122
|
+
# CloudGrid-correct way to inject them — the platform resolves each vault item and
|
|
123
|
+
# sets the named env var at runtime. Add the vault items with `grid secrets set`
|
|
124
|
+
# (or via the vault UI) BEFORE plug so resolution succeeds.
|
|
125
|
+
vault:
|
|
126
|
+
STRIPE_KEY: stripe-live-key
|
|
127
|
+
STRIPE_WEBHOOK_SECRET: stripe-webhook-secret
|
|
128
|
+
AUTH_PROVIDER_KEY: auth-provider-key
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
# ─── CONNECTORS AND HOOKS ──────────────────────────────────────────────────
|
|
132
|
+
|
|
133
|
+
# connectors:
|
|
134
|
+
# - id: team-slack
|
|
135
|
+
# target: org # 'system' | 'org'.
|
|
136
|
+
# channel: "#deploys"
|
|
137
|
+
# hooks:
|
|
138
|
+
# - on: deploy.failed # release.published | deploy.failed | feedback.received | entity.created
|
|
139
|
+
# via: team-slack
|
|
140
|
+
# template: "Deploy failed for {entity_name}: {error}"
|
|
141
|
+
# channel: "#alerts"
|
|
142
|
+
# triggers:
|
|
143
|
+
# - from: team-slack
|
|
144
|
+
# event: message
|
|
145
|
+
# channel: "#support"
|
|
146
|
+
# route: /webhooks/slack
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
# ─── LOCAL DEVELOPMENT ──────────────────────────────────────────────────────
|
|
150
|
+
|
|
151
|
+
# Config for `grid dev`. Redact fields in dev data snapshots.
|
|
152
|
+
# dev:
|
|
153
|
+
# snapshot:
|
|
154
|
+
# mask:
|
|
155
|
+
# - users.email
|
|
156
|
+
# - users.phone
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
# ─── AGENT METADATA ────────────────────────────────────────────────────────
|
|
160
|
+
|
|
161
|
+
# An agent is an app with kind: agent (above) and an agent: block.
|
|
162
|
+
# agent:
|
|
163
|
+
# purpose: Sync customer data from external CRM every night
|
|
164
|
+
# schedule: "0 2 * * *"
|
|
165
|
+
# trigger: webhook
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
# ─── PRIVATE RESOURCE AUTO-DEPENDENCIES ────────────────────────────────────
|
|
169
|
+
|
|
170
|
+
# When true (default), private resources are auto-injected as depends_on.
|
|
171
|
+
# auto_depends_on_private_requires: true
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
# ─── SERVICES (REQUIRED) ───────────────────────────────────────────────────
|
|
175
|
+
#
|
|
176
|
+
# At least one service is required. Key = service name (slug rules).
|
|
177
|
+
# Types: node, nextjs, python, static, cron.
|
|
178
|
+
#
|
|
179
|
+
services:
|
|
180
|
+
web:
|
|
181
|
+
# type (REQUIRED): node | nextjs | python | static | cron
|
|
182
|
+
type: nextjs
|
|
183
|
+
# HTTP route: '/' | '/api' | false (internal) | omitted (=false + warning).
|
|
184
|
+
# Only one service per entity can claim '/'.
|
|
185
|
+
path: /
|
|
186
|
+
# Container port (default 8080; read process.env.PORT). Not for cron.
|
|
187
|
+
# port: 3000
|
|
188
|
+
# nextjs only: base_image: distroless (default) | alpine
|
|
189
|
+
# base_image: distroless
|
|
190
|
+
# node only: lang: javascript (default) | typescript
|
|
191
|
+
# lang: typescript
|
|
192
|
+
# Custom source location (default services/<name>/). '.' = project root.
|
|
193
|
+
# source:
|
|
194
|
+
# path: src/worker
|
|
195
|
+
# Health probe: false/omitted (TCP) | true (/health) | "/path" | {path,expected}
|
|
196
|
+
# health:
|
|
197
|
+
# path: /api/health
|
|
198
|
+
# expected: "200"
|
|
199
|
+
# Static runtime env vars (strings). Reserved: PORT, APP_NAME, SERVICE_NAME,
|
|
200
|
+
# NODE_ENV, MONGODB_URL, REDIS_URL, AI_GATEWAY_URL, N8N_WEBHOOK_URL, CLOUDGRID_*.
|
|
201
|
+
# env:
|
|
202
|
+
# LOG_LEVEL: info
|
|
203
|
+
# Sibling services/private resources that must be Ready first (no cron, no cycles).
|
|
204
|
+
# depends_on:
|
|
205
|
+
# - worker
|
|
206
|
+
# Per-service needs override (merges with app-level needs).
|
|
207
|
+
# needs:
|
|
208
|
+
# queue: true
|
|
209
|
+
# Static-only build step:
|
|
210
|
+
# build:
|
|
211
|
+
# command: npm run build
|
|
212
|
+
# output: dist
|
|
213
|
+
# env:
|
|
214
|
+
# VITE_API_URL: https://api.example.com
|
|
215
|
+
# node_version: "22" # static build step: '18'|'20'|'22'|'24' (quoted)
|
|
216
|
+
# Cron-only: schedule (REQUIRED), timezone (UTC|EST|PST), run (job | https URL)
|
|
217
|
+
# schedule: "0 9 * * 1"
|
|
218
|
+
# timezone: UTC
|
|
219
|
+
# run: job
|
|
220
|
+
# Verbose per-service persistence (prefer needs.disk):
|
|
221
|
+
# persist:
|
|
222
|
+
# - name: scratch
|
|
223
|
+
# path: /tmp/scratch
|
|
224
|
+
# size: 500Mi
|
|
225
|
+
|
|
226
|
+
# ─── CRON SERVICE (INTENDED SHAPE — NOT YET DEPLOYABLE) ───────────────────
|
|
227
|
+
# A booking system needs a scheduled job to send appointment reminders. This is
|
|
228
|
+
# the intended shape. cron deploy is currently PENDING platform issue #1543 — do
|
|
229
|
+
# NOT uncomment this yet; plug will reject a cron service until #1543 lands.
|
|
230
|
+
# See AGENTS.md for the reminder-job design.
|
|
231
|
+
# reminders:
|
|
232
|
+
# type: cron
|
|
233
|
+
# schedule: "*/15 * * * *" # every 15 min: scan for bookings needing a reminder
|
|
234
|
+
# timezone: UTC
|
|
235
|
+
# run: job # runs services/reminders/ as a batch job (no HTTP)
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
needs:
|
|
239
|
+
database: true
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
# ============================================================================
|
|
243
|
+
# NOTES
|
|
244
|
+
# - NOT here: org:/entity_id: (→ .cloudgrid/link.json), secrets (→ grid secrets set),
|
|
245
|
+
# Dockerfile (platform generates from services.*.type).
|
|
246
|
+
# - Deploy: grid plug | Local with grid resources: grid dev
|
|
247
|
+
# - Full reference: docs/cloudgrid-yaml-reference.md | CLI: docs/cli-reference.md
|
|
248
|
+
# ============================================================================
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# Template: booking-system (BLUEPRINT — Next.js + Mongo reservations)
|
|
2
|
+
|
|
3
|
+
A blueprint for an appointment / reservation booking system. Data lives in
|
|
4
|
+
grid-shared MongoDB so bookings survive refresh and are shared across sessions —
|
|
5
|
+
a runtime app, not a static page. This bundle ships the annotated `cloudgrid.yaml`
|
|
6
|
+
and the `AGENTS.md` structure guide, NOT prewritten app code.
|
|
7
|
+
|
|
8
|
+
**This is a blueprint: structure + cloudgrid.yaml, adapt and build.** Fetch it,
|
|
9
|
+
read `AGENTS.md`, then build the app under `services/web/` following the file
|
|
10
|
+
tree and data model there. The proven runtime shape is the same as
|
|
11
|
+
`app-with-data` (lazy Mongo client under `services/web/`).
|
|
12
|
+
|
|
13
|
+
**Key rules:**
|
|
14
|
+
|
|
15
|
+
1. **Service code MUST live under `services/<name>/`, not the repo root.** `path:`
|
|
16
|
+
in `cloudgrid.yaml` is the URL mount, NOT the filesystem path. The service
|
|
17
|
+
named `web` → the CLI looks for `services/web/`. Root files fail with
|
|
18
|
+
`Error: Service directory not found: …/services/web`.
|
|
19
|
+
2. **Read injected vars LAZILY (inside getters), never at module top level.** The
|
|
20
|
+
grid injects `DATABASE_MONGODB_URL` (legacy `MONGODB_URL` alias) from
|
|
21
|
+
`needs: { database: true }`, and the `vault:` secrets (`STRIPE_KEY`,
|
|
22
|
+
`STRIPE_WEBHOOK_SECRET`, `AUTH_PROVIDER_KEY`) as env vars. A top-level read
|
|
23
|
+
fails `next build`. Never hardcode a key; never commit a secret.
|
|
24
|
+
3. **Declare the datastore with `needs: { database: true }`** — the canonical
|
|
25
|
+
shape. `requires:` is the deprecated v1 alias; don't author new yaml with it,
|
|
26
|
+
and never set `needs:` and `requires:` together (the validator rejects it).
|
|
27
|
+
4. **Payment/auth secrets go through the `vault:` block**, resolved to env vars
|
|
28
|
+
at deploy — add the vault items with `grid secrets set` before plug.
|
|
29
|
+
5. **The reminder cron service is NOT yet deployable** (platform issue #1543).
|
|
30
|
+
Keep the `reminders:` cron COMMENTED and ship `web` alone; see `AGENTS.md` §7.
|
|
31
|
+
|
|
32
|
+
## cloudgrid.yaml
|
|
33
|
+
|
|
34
|
+
```yaml
|
|
35
|
+
# On disk this file is the full-annotated reference (templates/_cloudgrid.yaml.reference) with EVERY
|
|
36
|
+
# field present as a comment; only the fields below are uncommented, so it
|
|
37
|
+
# deploys to exactly these active fields. (A commented `reminders:` cron service
|
|
38
|
+
# shows the intended — not-yet-deployable — shape; see AGENTS.md §7.)
|
|
39
|
+
name: booking-system
|
|
40
|
+
vault:
|
|
41
|
+
STRIPE_KEY: stripe-live-key
|
|
42
|
+
STRIPE_WEBHOOK_SECRET: stripe-webhook-secret
|
|
43
|
+
AUTH_PROVIDER_KEY: auth-provider-key
|
|
44
|
+
services:
|
|
45
|
+
web:
|
|
46
|
+
type: nextjs
|
|
47
|
+
path: /
|
|
48
|
+
needs:
|
|
49
|
+
database: true
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
> **Capability:** need is `database: true` — the deployer provisions Mongo and
|
|
53
|
+
> injects `DATABASE_MONGODB_URL` (plus the legacy `MONGODB_URL` alias). Secrets
|
|
54
|
+
> come from the `vault:` block as env vars. See the capability-map for the full
|
|
55
|
+
> injection table.
|
|
56
|
+
|
|
57
|
+
## AGENTS.md — the structure guide
|
|
58
|
+
|
|
59
|
+
The heart of this blueprint. Read it before building. It covers:
|
|
60
|
+
|
|
61
|
+
1. **File tree** — `services/web/{app/, lib/, api routes, package.json}` with a
|
|
62
|
+
booking flow, availability + Stripe + auth libs, and the API routes
|
|
63
|
+
(services / availability / bookings / Stripe webhook).
|
|
64
|
+
2. **Mongo collections + fields** — `services`, `availabilityRules`, `bookings`,
|
|
65
|
+
plus the overlap-check + unique-index rule that prevents double-booking.
|
|
66
|
+
3. **CloudGrid injection** — `DATABASE_MONGODB_URL` for Mongo, `vault:` → env
|
|
67
|
+
vars for secrets, `AI_GATEWAY_URL` for ai.
|
|
68
|
+
4. **Auth + payments wiring** — provider SDK from `AUTH_PROVIDER_KEY`; Stripe
|
|
69
|
+
checkout + signature-verified webhook from `STRIPE_KEY` /
|
|
70
|
+
`STRIPE_WEBHOOK_SECRET`.
|
|
71
|
+
5. **Deploy steps** — `grid init` → fill → `grid secrets set` → `grid plug` →
|
|
72
|
+
poll to live.
|
|
73
|
+
6. **Edition note** — runtime app → local edition only (hosted is static-only).
|
|
74
|
+
7. **Reminder cron** — intended shape + the platform-issue-#1543 PENDING note and
|
|
75
|
+
stopgap.
|
|
76
|
+
|
|
77
|
+
## Adapt it
|
|
78
|
+
|
|
79
|
+
- Rename `services` / `bookings` collections and fields to your domain (rooms,
|
|
80
|
+
tables, resources, classes).
|
|
81
|
+
- Swap the auth provider (Clerk / Auth0 / …) and payment flow (or drop Stripe for
|
|
82
|
+
free bookings — skip checkout, mark `confirmed`).
|
|
83
|
+
- Add `needs: { cache: true }` only if you actually need Redis (e.g. slot-hold
|
|
84
|
+
locks).
|
|
85
|
+
- Wire the reminder cron once platform issue #1543 lands; until then use the
|
|
86
|
+
stopgap in `AGENTS.md` §7.
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# AGENTS.md — calendar-scheduler blueprint (structure guide)
|
|
2
|
+
|
|
3
|
+
This is a **blueprint**, not a runnable app. It ships a `cloudgrid.yaml` and this
|
|
4
|
+
guide so an agent can *build* a calendar / scheduling app correctly on CloudGrid.
|
|
5
|
+
There is no app code to copy — read this, generate the files, then deploy.
|
|
6
|
+
|
|
7
|
+
A calendar scheduler is a persistent Next.js + Mongo runtime app (same base shape
|
|
8
|
+
as `app-with-data` / `crm`) whose domain is **events and availability**: users
|
|
9
|
+
create events on a calendar, define bookable time slots, and (optionally) let
|
|
10
|
+
others book them. Its distinguishing concern is **time** — timezones, recurrence,
|
|
11
|
+
overlap detection, and **scheduled reminders**. Reminders want a `cron` service;
|
|
12
|
+
that shape is documented in §5, but cron deploy is **BLOCKED on platform issue
|
|
13
|
+
#1543** — build the HTTP app now, add cron once #1543 ships.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 1. File tree
|
|
18
|
+
|
|
19
|
+
App code MUST live under `services/web/` — `path: /` in `cloudgrid.yaml` is the
|
|
20
|
+
URL mount, NOT the filesystem path. Files at the repo root fail with
|
|
21
|
+
`Error: Service directory not found: …/services/web`.
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
cloudgrid.yaml # name + services.web(nextjs,/) + needs:{database:true} (+ optional vault, + optional cron — see §5)
|
|
25
|
+
services/web/
|
|
26
|
+
package.json # next, react, react-dom, mongodb (+ optional: auth SDK, stripe, a date lib like luxon/date-fns-tz)
|
|
27
|
+
lib/
|
|
28
|
+
db.js # lazy Mongo client from DATABASE_MONGODB_URL (legacy MONGODB_URL fallback) — see §3 rule
|
|
29
|
+
time.js # pure time helpers: toUTC/fromUTC, expandRecurrence(), slotsForDay(), overlaps(a,b)
|
|
30
|
+
auth.js # (optional) provider SDK init from AUTH_PROVIDER_KEY; getCurrentUser()
|
|
31
|
+
app/
|
|
32
|
+
layout.js # root layout + inline CSS (+ auth provider wrapper if used)
|
|
33
|
+
page.js # server component: month/week calendar grid, reads events from Mongo
|
|
34
|
+
events/[id]/page.js # event detail / edit
|
|
35
|
+
book/[slug]/page.js # (optional) public booking page for a shareable availability link
|
|
36
|
+
api/
|
|
37
|
+
events/route.js # GET (range query ?from&to) / POST (create) — App-Router CRUD
|
|
38
|
+
events/[id]/route.js # GET one / PATCH (reschedule/edit) / DELETE
|
|
39
|
+
availability/route.js # GET open slots for a day/range (derives from availability - bookings)
|
|
40
|
+
bookings/route.js # (optional) POST to book a slot -> creates an event, guards double-booking
|
|
41
|
+
middleware.js # (optional) gate /events/** + write APIs behind auth
|
|
42
|
+
services/reminders/ # (optional, BLOCKED #1543) cron job: scan due reminders, send mail/SMS — see §5
|
|
43
|
+
job.js
|
|
44
|
+
package.json
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Keep it minimal and real; grow routes/collections as needed. Reuse the
|
|
48
|
+
`app-with-data` App-Router GET/POST/PATCH/DELETE route shape for the CRUD parts.
|
|
49
|
+
Store all times as **UTC `Date`** in Mongo; convert at the edges in `lib/time.js`.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 2. Mongo collections + fields
|
|
54
|
+
|
|
55
|
+
The grid provisions one MongoDB database (`needs: { database: true }`). Suggested
|
|
56
|
+
collections (`_id` is the Mongo ObjectId on every doc):
|
|
57
|
+
|
|
58
|
+
**`events`** — a scheduled item on the calendar
|
|
59
|
+
- `ownerId` (string, from auth provider — omit if single-user/no auth)
|
|
60
|
+
- `title` (string), `description` (string)
|
|
61
|
+
- `startAt` (Date, UTC), `endAt` (Date, UTC)
|
|
62
|
+
- `timezone` (string, IANA e.g. `"America/New_York"` — the zone the user entered it in)
|
|
63
|
+
- `allDay` (bool)
|
|
64
|
+
- `recurrence` (string | null — an RRULE, e.g. `"FREQ=WEEKLY;BYDAY=MO,WE"`; expand at read time in `lib/time.js`, do not store every instance)
|
|
65
|
+
- `attendees` (array of `{ email, status: "invited"|"accepted"|"declined" }`)
|
|
66
|
+
- `reminderMinutes` (number | null — minutes-before to notify; drives the cron job)
|
|
67
|
+
- `reminderSentAt` (Date | null — set by the reminder job to avoid double-send)
|
|
68
|
+
- `createdAt` (Date)
|
|
69
|
+
|
|
70
|
+
**`availability`** — recurring bookable windows (for the scheduling/booking use)
|
|
71
|
+
- `ownerId` (string)
|
|
72
|
+
- `weekday` (number 0–6) or `date` (Date) for one-off windows
|
|
73
|
+
- `startMinute` (number, minutes from midnight in `timezone`), `endMinute` (number)
|
|
74
|
+
- `slotMinutes` (number — slot length, e.g. 30), `timezone` (string, IANA)
|
|
75
|
+
- `bufferMinutes` (number — gap between bookings)
|
|
76
|
+
|
|
77
|
+
**`bookings`** — (optional) an external booking against an availability window
|
|
78
|
+
- `ownerId` (string — whose calendar), `slotStartAt` (Date, UTC), `slotEndAt` (Date, UTC)
|
|
79
|
+
- `bookerName` (string), `bookerEmail` (string), `note` (string)
|
|
80
|
+
- `eventId` (ObjectId ref → events — the event row this booking created)
|
|
81
|
+
- `status` (string: `confirmed` | `cancelled`)
|
|
82
|
+
- `createdAt` (Date)
|
|
83
|
+
|
|
84
|
+
Index for the calendar range query and overlap checks:
|
|
85
|
+
`db.collection("events").createIndex({ ownerId: 1, startAt: 1 })` and a query on
|
|
86
|
+
`{ startAt: { $lt: rangeEnd }, endAt: { $gt: rangeStart } }` for the visible window.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 3. How CloudGrid injects things
|
|
91
|
+
|
|
92
|
+
You never provision infra or set connection strings by hand. Declared inputs are
|
|
93
|
+
injected as env vars at `grid dev` (local) and at runtime (after `grid plug`):
|
|
94
|
+
|
|
95
|
+
| What | Declared in cloudgrid.yaml | Injected env var(s) | Read in code |
|
|
96
|
+
|------|----------------------------|---------------------|--------------|
|
|
97
|
+
| MongoDB | `needs: { database: true }` | `DATABASE_MONGODB_URL` (+ legacy `MONGODB_URL`) | `lib/db.js` |
|
|
98
|
+
| Auth provider key (optional) | `vault: { AUTH_PROVIDER_KEY: auth-provider-key }` | `AUTH_PROVIDER_KEY` | `lib/auth.js` |
|
|
99
|
+
| Stripe secret (optional, paid booking) | `vault: { STRIPE_KEY: stripe-live-key }` | `STRIPE_KEY` | `lib/stripe.js` |
|
|
100
|
+
| Stripe webhook secret (optional) | `vault: { STRIPE_WEBHOOK_SECRET: stripe-webhook-secret }` | `STRIPE_WEBHOOK_SECRET` | `api/webhooks/stripe/route.js` |
|
|
101
|
+
| Email/SMS key (optional, reminders) | `vault: { SENDGRID_API_KEY: sendgrid-key }` | `SENDGRID_API_KEY` | reminder job / `lib/notify.js` |
|
|
102
|
+
| AI (optional) | `needs: { ai: true }` | `AI_GATEWAY_URL` | via `@cloudgrid-io/ai` |
|
|
103
|
+
|
|
104
|
+
The `vault:` block only **maps** an org vault item key → an env var name. You must
|
|
105
|
+
store the real value once with `grid secrets set <vault-item-key> <value>` (e.g.
|
|
106
|
+
`grid secrets set sendgrid-key SG.xxx`). Non-secret public config (a public auth
|
|
107
|
+
key, a base URL) → `grid env`. Never commit a secret; never hardcode a connection
|
|
108
|
+
string. The base template ships with `needs: { database: true }` only — the vault
|
|
109
|
+
block stays commented until you actually add auth / payments / reminders.
|
|
110
|
+
|
|
111
|
+
**DB read rule (critical):** read the Mongo URL LAZILY inside a getter, never at
|
|
112
|
+
module top level — a top-level `const uri = process.env.DATABASE_MONGODB_URL`
|
|
113
|
+
fails `next build` (the module is imported for route analysis before the grid
|
|
114
|
+
injects the var). Same lazy pattern for any Stripe / provider client.
|
|
115
|
+
|
|
116
|
+
```js
|
|
117
|
+
// lib/db.js — same proven shape as app-with-data
|
|
118
|
+
import { MongoClient } from "mongodb";
|
|
119
|
+
export async function getDb() {
|
|
120
|
+
const uri = process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL;
|
|
121
|
+
if (!uri) throw new Error("DATABASE_MONGODB_URL not set — run via `grid dev` / `grid plug`.");
|
|
122
|
+
globalThis.__mongo ??= new MongoClient(uri).connect();
|
|
123
|
+
return (await globalThis.__mongo).db();
|
|
124
|
+
}
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 4. Wiring auth + payments (optional layers)
|
|
130
|
+
|
|
131
|
+
Both are optional — a personal single-user calendar needs neither. Add them only
|
|
132
|
+
when the use demands it, and always through the vault → env-var mechanism above.
|
|
133
|
+
|
|
134
|
+
### Auth (multi-user calendars, invites, per-user availability)
|
|
135
|
+
- Pick a provider SDK: **Clerk** (`@clerk/nextjs`) or **Auth0**
|
|
136
|
+
(`@auth0/nextjs-auth0`). Add it to `package.json`.
|
|
137
|
+
- Initialize it in `lib/auth.js` from `process.env.AUTH_PROVIDER_KEY` (vault). A
|
|
138
|
+
public key (if the provider needs one client-side) is non-secret → `grid env`.
|
|
139
|
+
- Stamp `ownerId` on every `events` / `availability` / `bookings` write with the
|
|
140
|
+
signed-in user id, and filter reads by it.
|
|
141
|
+
- In `middleware.js`, gate the write APIs and the owner's dashboard; leave the
|
|
142
|
+
public `book/[slug]` page + the read side of `availability` open so external
|
|
143
|
+
people can book without an account.
|
|
144
|
+
|
|
145
|
+
### Payments (paid bookings / deposits — the booking-SaaS shape)
|
|
146
|
+
- Add `stripe` to `package.json`; init a lazy client in `lib/stripe.js` from
|
|
147
|
+
`process.env.STRIPE_KEY` (vault). Map `STRIPE_KEY` and `STRIPE_WEBHOOK_SECRET`
|
|
148
|
+
in the `vault:` block.
|
|
149
|
+
- On booking a paid slot, create a Stripe **Checkout Session** (`mode: "payment"`)
|
|
150
|
+
and create the `bookings`/`events` doc as `pending`.
|
|
151
|
+
- Add `api/webhooks/stripe/route.js`: verify the signature with
|
|
152
|
+
`stripe().webhooks.constructEvent(rawBody, sig, process.env.STRIPE_WEBHOOK_SECRET)`
|
|
153
|
+
(read the RAW body — do NOT JSON-parse before verifying) and on
|
|
154
|
+
`checkout.session.completed` mark the booking `confirmed`. Point the Stripe
|
|
155
|
+
dashboard webhook at `<live-url>/api/webhooks/stripe`.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## 5. Scheduled reminders (cron) — INTENDED SHAPE, BLOCKED on #1543
|
|
160
|
+
|
|
161
|
+
A calendar scheduler wants scheduled work: every few minutes, find events whose
|
|
162
|
+
reminder is due and send an email/SMS. On CloudGrid that is a **second service of
|
|
163
|
+
`type: cron`** in the same entity, sharing the app-level Mongo.
|
|
164
|
+
|
|
165
|
+
**PLATFORM STATUS — NOT YET DEPLOYABLE.** Cron deploy is a **PENDING platform
|
|
166
|
+
issue (#1543)**. Do NOT uncomment the cron service in `cloudgrid.yaml` yet;
|
|
167
|
+
plugging it today will not schedule the job. Ship the HTTP app now; add the cron
|
|
168
|
+
service once #1543 lands. Until then, this is the intended shape only.
|
|
169
|
+
|
|
170
|
+
Intended `cloudgrid.yaml` addition (currently commented in the shipped file):
|
|
171
|
+
|
|
172
|
+
```yaml
|
|
173
|
+
services:
|
|
174
|
+
web:
|
|
175
|
+
type: nextjs
|
|
176
|
+
path: /
|
|
177
|
+
reminders: # BLOCKED #1543 — do not uncomment until it ships
|
|
178
|
+
type: cron
|
|
179
|
+
schedule: "*/15 * * * *" # every 15 min
|
|
180
|
+
timezone: UTC # UTC | EST | PST
|
|
181
|
+
run: job # run the container's default job (or an https URL)
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Intended job (`services/reminders/job.js`): reads `DATABASE_MONGODB_URL` the same
|
|
185
|
+
lazy way, queries
|
|
186
|
+
`events` where `reminderMinutes != null`, `reminderSentAt == null`, and
|
|
187
|
+
`startAt <= now + reminderMinutes`, sends via the mail/SMS provider (its key mapped
|
|
188
|
+
in `vault:`), then sets `reminderSentAt` so it never double-sends. A cron service
|
|
189
|
+
has NO `path` (no HTTP route) and shares the app-level `needs.database`.
|
|
190
|
+
|
|
191
|
+
Interim workaround until #1543: trigger reminders from an external scheduler
|
|
192
|
+
hitting an authenticated HTTP route on `web` (e.g. `POST /api/cron/reminders`
|
|
193
|
+
guarded by a shared secret from the vault), instead of a `type: cron` service.
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## 6. Deploy steps
|
|
198
|
+
|
|
199
|
+
Runtime app → **local edition** only (Claude Desktop / Claude Code / CLI); the
|
|
200
|
+
hosted edition cannot build a runtime container. Order matters — `plug` needs a
|
|
201
|
+
linked directory, so `init` first.
|
|
202
|
+
|
|
203
|
+
1. `grid init` (or `gridctl_init`) an app `<name>` — creates the entity +
|
|
204
|
+
`.cloudgrid/link.json` and a starter `cloudgrid.yaml` with empty `services:{}`.
|
|
205
|
+
2. Fill: put the app under `services/web/` and set `cloudgrid.yaml` to this
|
|
206
|
+
blueprint's active fields (`services.web` nextjs `/`, `needs:{database:true}`).
|
|
207
|
+
Uncomment a `vault:` entry only if you added auth / payments / reminders.
|
|
208
|
+
3. (If you mapped vault items) store the values:
|
|
209
|
+
`grid secrets set <vault-item-key> <value>`. Non-secret public config → `grid env`.
|
|
210
|
+
Do NOT set `DATABASE_MONGODB_URL` / `MONGODB_URL` yourself — the grid injects them.
|
|
211
|
+
4. (Optional) `grid dev` to run locally against the injected dev Mongo (+ secrets).
|
|
212
|
+
5. `grid plug` to deploy. A runtime deploy is **ASYNC** — the first response is
|
|
213
|
+
`status: building`, not a live URL. Poll `grid status` (surface a liveness
|
|
214
|
+
signal, never a bare wait) until Ready.
|
|
215
|
+
6. Once live, return the app URL. Re-plug the same entity to update the same URL.
|
|
216
|
+
(Do NOT add the cron `reminders` service until #1543 ships — see §5.)
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## 7. Edition note
|
|
221
|
+
|
|
222
|
+
Because this is a built + deployed container (Next.js + Mongo), it requires the
|
|
223
|
+
**local edition** (Claude Desktop / Claude Code) or the CLI. The hosted edition
|
|
224
|
+
(Claude Web / hosted MCP) is inline-only and can only publish static pages —
|
|
225
|
+
offer a static calendar mockup there, but the real scheduler must be built and
|
|
226
|
+
plugged from the local edition.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# calendar-scheduler template — calendar / scheduling app blueprint
|
|
2
|
+
|
|
3
|
+
A blueprint for a calendar scheduler on CloudGrid: a persistent Next.js + Mongo
|
|
4
|
+
app whose domain is events and availability (`events`, `availability`, optional
|
|
5
|
+
`bookings`) — create events on a calendar, define bookable slots, handle
|
|
6
|
+
timezones and recurrence, and (once platform issue #1543 ships) fire scheduled
|
|
7
|
+
reminders from a `cron` service. Because a real scheduler involves choices (auth
|
|
8
|
+
or single-user, paid bookings or not, which date library), this template ships
|
|
9
|
+
the **structure and `cloudgrid.yaml`, not finished app code** — you adapt it and build.
|
|
10
|
+
|
|
11
|
+
> **This is a blueprint: structure + cloudgrid.yaml, adapt and build.** Read
|
|
12
|
+
> `AGENTS.md` for the file tree, Mongo collections, CloudGrid injection table
|
|
13
|
+
> (needs + optional vault), the optional auth/payments layers, the intended cron
|
|
14
|
+
> reminder shape (BLOCKED on #1543), and the deploy flow — then generate the app
|
|
15
|
+
> under `services/web/` and `grid plug` it (runtime, local edition, async — poll
|
|
16
|
+
> to a live URL).
|
|
17
|
+
|
|
18
|
+
## Files
|
|
19
|
+
|
|
20
|
+
- `cloudgrid.yaml` — active fields: `name`, `services.web` (nextjs, `/`),
|
|
21
|
+
`needs: { database: true }`. Includes a COMMENTED cron `reminders` service
|
|
22
|
+
(intended shape; not yet deployable — platform issue #1543) and a commented
|
|
23
|
+
`vault:` block for optional auth / payments / reminder-provider secrets.
|
|
24
|
+
- `AGENTS.md` — the structure guide (read this first).
|
|
25
|
+
- `index.md` — the fetch-bundle summary + cloudgrid.yaml.
|