@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,238 @@
|
|
|
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: my-knowledge-base
|
|
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
|
+
# # NOTE: `needs: vector` (pgvector) is the intended store for RAG embeddings but
|
|
93
|
+
# # is PENDING platform issue #1545 — not yet provisioned. Until it ships, store
|
|
94
|
+
# # embeddings in Mongo (a `chunks` collection with an `embedding: number[]` field)
|
|
95
|
+
# # and do cosine similarity in the app. Flip this on once #1545 lands.
|
|
96
|
+
# vector: pgvector
|
|
97
|
+
# # object_storage — GCS bucket. Injects OBJECT_STORAGE_GCS_BUCKET, _GCS_REGION.
|
|
98
|
+
# # true | { size: 10Gi }
|
|
99
|
+
# object_storage: true
|
|
100
|
+
# # disk — persistent FS mount (PVC). Injects DISK_PATH. Pins to 1 replica.
|
|
101
|
+
# # true | { size: 1Gi, mount: /var/data } (forbidden: /proc /sys /dev)
|
|
102
|
+
# disk: true
|
|
103
|
+
# ai — AI Gateway via @cloudgrid-io/ai. Injects AI_GATEWAY_URL. true | false.
|
|
104
|
+
# Powers embeddings (for indexing docs + queries) and chat completions (the
|
|
105
|
+
# answer step). Works today.
|
|
106
|
+
ai: true
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
# ─── INTER-ENTITY COMMUNICATION ────────────────────────────────────────────
|
|
110
|
+
|
|
111
|
+
# Entities this app calls (outbound). Service-account token injected per pair.
|
|
112
|
+
# calls:
|
|
113
|
+
# - org:atomic/billing-api
|
|
114
|
+
|
|
115
|
+
# Inbound caller policy — who can call YOUR entity.
|
|
116
|
+
# callers:
|
|
117
|
+
# policy: auto # 'auto' | 'manual' (default).
|
|
118
|
+
# scope: org # 'org' (default) | 'space' | 'explicit'.
|
|
119
|
+
# fallback: deny # 'deny' (default) | 'warn'.
|
|
120
|
+
# # allowed_apps: # required only when scope: explicit
|
|
121
|
+
# # - org:atomic/frontend
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
# ─── VAULT ──────────────────────────────────────────────────────────────────
|
|
125
|
+
|
|
126
|
+
# Map org vault items to env vars. Keys UPPER_SNAKE_CASE; values = vault item keys.
|
|
127
|
+
# This RAG blueprint needs NO secret by default — the AI Gateway is injected via
|
|
128
|
+
# `needs: { ai: true }` (no API key to manage). Uncomment a vault block ONLY if
|
|
129
|
+
# you add auth (gate the chat UI) or payments. Store the value once with
|
|
130
|
+
# `grid secrets set <vault-item-key> …`; the block only maps it to an env var.
|
|
131
|
+
# vault:
|
|
132
|
+
# AUTH_PROVIDER_KEY: auth-provider-key # if you gate the KB behind Clerk/Auth0
|
|
133
|
+
# STRIPE_KEY: stripe-live-key # if you charge for access
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
# ─── CONNECTORS AND HOOKS ──────────────────────────────────────────────────
|
|
137
|
+
|
|
138
|
+
# connectors:
|
|
139
|
+
# - id: team-slack
|
|
140
|
+
# target: org # 'system' | 'org'.
|
|
141
|
+
# channel: "#deploys"
|
|
142
|
+
# hooks:
|
|
143
|
+
# - on: deploy.failed # release.published | deploy.failed | feedback.received | entity.created
|
|
144
|
+
# via: team-slack
|
|
145
|
+
# template: "Deploy failed for {entity_name}: {error}"
|
|
146
|
+
# channel: "#alerts"
|
|
147
|
+
# triggers:
|
|
148
|
+
# - from: team-slack
|
|
149
|
+
# event: message
|
|
150
|
+
# channel: "#support"
|
|
151
|
+
# route: /webhooks/slack
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
# ─── LOCAL DEVELOPMENT ──────────────────────────────────────────────────────
|
|
155
|
+
|
|
156
|
+
# Config for `grid dev`. Redact fields in dev data snapshots.
|
|
157
|
+
# dev:
|
|
158
|
+
# snapshot:
|
|
159
|
+
# mask:
|
|
160
|
+
# - users.email
|
|
161
|
+
# - users.phone
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
# ─── AGENT METADATA ────────────────────────────────────────────────────────
|
|
165
|
+
|
|
166
|
+
# An agent is an app with kind: agent (above) and an agent: block.
|
|
167
|
+
# agent:
|
|
168
|
+
# purpose: Sync customer data from external CRM every night
|
|
169
|
+
# schedule: "0 2 * * *"
|
|
170
|
+
# trigger: webhook
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
# ─── PRIVATE RESOURCE AUTO-DEPENDENCIES ────────────────────────────────────
|
|
174
|
+
|
|
175
|
+
# When true (default), private resources are auto-injected as depends_on.
|
|
176
|
+
# auto_depends_on_private_requires: true
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
# ─── SERVICES (REQUIRED) ───────────────────────────────────────────────────
|
|
180
|
+
#
|
|
181
|
+
# At least one service is required. Key = service name (slug rules).
|
|
182
|
+
# Types: node, nextjs, python, static, cron.
|
|
183
|
+
#
|
|
184
|
+
services:
|
|
185
|
+
web:
|
|
186
|
+
# type (REQUIRED): node | nextjs | python | static | cron
|
|
187
|
+
type: nextjs
|
|
188
|
+
# HTTP route: '/' | '/api' | false (internal) | omitted (=false + warning).
|
|
189
|
+
# Only one service per entity can claim '/'.
|
|
190
|
+
path: /
|
|
191
|
+
# Container port (default 8080; read process.env.PORT). Not for cron.
|
|
192
|
+
# port: 3000
|
|
193
|
+
# nextjs only: base_image: distroless (default) | alpine
|
|
194
|
+
# base_image: distroless
|
|
195
|
+
# node only: lang: javascript (default) | typescript
|
|
196
|
+
# lang: typescript
|
|
197
|
+
# Custom source location (default services/<name>/). '.' = project root.
|
|
198
|
+
# source:
|
|
199
|
+
# path: src/worker
|
|
200
|
+
# Health probe: false/omitted (TCP) | true (/health) | "/path" | {path,expected}
|
|
201
|
+
# health:
|
|
202
|
+
# path: /api/health
|
|
203
|
+
# expected: "200"
|
|
204
|
+
# Static runtime env vars (strings). Reserved: PORT, APP_NAME, SERVICE_NAME,
|
|
205
|
+
# NODE_ENV, MONGODB_URL, REDIS_URL, AI_GATEWAY_URL, N8N_WEBHOOK_URL, CLOUDGRID_*.
|
|
206
|
+
# env:
|
|
207
|
+
# LOG_LEVEL: info
|
|
208
|
+
# Sibling services/private resources that must be Ready first (no cron, no cycles).
|
|
209
|
+
# depends_on:
|
|
210
|
+
# - worker
|
|
211
|
+
# Per-service needs override (merges with app-level needs).
|
|
212
|
+
# needs:
|
|
213
|
+
# queue: true
|
|
214
|
+
# Static-only build step:
|
|
215
|
+
# build:
|
|
216
|
+
# command: npm run build
|
|
217
|
+
# output: dist
|
|
218
|
+
# env:
|
|
219
|
+
# VITE_API_URL: https://api.example.com
|
|
220
|
+
# node_version: "22" # static build step: '18'|'20'|'22'|'24' (quoted)
|
|
221
|
+
# Cron-only: schedule (REQUIRED), timezone (UTC|EST|PST), run (job | https URL)
|
|
222
|
+
# schedule: "0 9 * * 1"
|
|
223
|
+
# timezone: UTC
|
|
224
|
+
# run: job
|
|
225
|
+
# Verbose per-service persistence (prefer needs.disk):
|
|
226
|
+
# persist:
|
|
227
|
+
# - name: scratch
|
|
228
|
+
# path: /tmp/scratch
|
|
229
|
+
# size: 500Mi
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
# ============================================================================
|
|
233
|
+
# NOTES
|
|
234
|
+
# - NOT here: org:/entity_id: (→ .cloudgrid/link.json), secrets (→ grid secrets set),
|
|
235
|
+
# Dockerfile (platform generates from services.*.type).
|
|
236
|
+
# - Deploy: grid plug | Local with grid resources: grid dev
|
|
237
|
+
# - Full reference: docs/cloudgrid-yaml-reference.md | CLI: docs/cli-reference.md
|
|
238
|
+
# ============================================================================
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Template: ai-knowledge-base (blueprint — RAG "ask my docs" on Next.js + Mongo + AI Gateway)
|
|
2
|
+
|
|
3
|
+
A **blueprint** for a retrieval-augmented knowledge base / "ask my docs" chatbot:
|
|
4
|
+
ingest documents, chunk + embed them, and answer questions grounded in the
|
|
5
|
+
retrieved chunks with citations. It is the persistent Next.js + Mongo runtime
|
|
6
|
+
shape (same base as `app-with-data` / `crm`) with a RAG loop layered on. This
|
|
7
|
+
template ships **structure, not app code** — read the structure guide, then build
|
|
8
|
+
the app following it.
|
|
9
|
+
|
|
10
|
+
**This is a blueprint (tier D):** the deliverable is `cloudgrid.yaml` +
|
|
11
|
+
`AGENTS.md`. Fetch the bundle, read `AGENTS.md`, then generate the files under
|
|
12
|
+
`services/web/` and deploy.
|
|
13
|
+
|
|
14
|
+
- **Structure guide:** `gridctl_fetch("template", "ai-knowledge-base")` → read
|
|
15
|
+
**`AGENTS.md`** (file tree, Mongo collections, CloudGrid injection table, the
|
|
16
|
+
RAG loop, the pgvector #1545 note, optional auth/payments, deploy steps).
|
|
17
|
+
|
|
18
|
+
**Key rules (same runtime discipline as `app-with-data`):**
|
|
19
|
+
|
|
20
|
+
1. **App code MUST live under `services/web/`, not the repo root.** `path: /` in
|
|
21
|
+
`cloudgrid.yaml` is the URL mount, NOT the filesystem path.
|
|
22
|
+
2. **Read injected values LAZILY (inside a getter), never at module top level** —
|
|
23
|
+
a top-level read fails `next build`. The grid injects `DATABASE_MONGODB_URL`
|
|
24
|
+
(+ legacy `MONGODB_URL`) for Mongo and `AI_GATEWAY_URL` for the AI Gateway.
|
|
25
|
+
3. **Declare `needs: { ai: true, database: true }`** (canonical shape). Never
|
|
26
|
+
author `requires:`, and never set `needs:` and `requires:` together (the
|
|
27
|
+
validator rejects the combination).
|
|
28
|
+
4. **Ground answers in retrieved chunks + cite them** — never answer from the
|
|
29
|
+
model's parametric memory alone. Keep chunking/retrieval as pure functions.
|
|
30
|
+
|
|
31
|
+
**Vector store:** `needs: vector` (pgvector, injecting `VECTOR_PGVECTOR_URL`) is
|
|
32
|
+
the intended embedding store but is **PENDING platform issue #1545**. The `ai`
|
|
33
|
+
part works today — until #1545 ships, store embeddings in a Mongo `chunks`
|
|
34
|
+
collection and rank by cosine similarity in the app; swap to a pgvector
|
|
35
|
+
ORDER-BY-distance query when it lands (see `AGENTS.md` §7).
|
|
36
|
+
|
|
37
|
+
Runtime app → **local edition** only (async build, poll to a live URL).
|
|
38
|
+
|
|
39
|
+
## cloudgrid.yaml
|
|
40
|
+
|
|
41
|
+
```yaml
|
|
42
|
+
# On disk this file is the full-annotated reference (templates/_cloudgrid.yaml.reference) with EVERY
|
|
43
|
+
# field present as a comment; only the fields below are uncommented, so it
|
|
44
|
+
# deploys to exactly these active fields. `vector: pgvector` is present but kept
|
|
45
|
+
# COMMENTED (PENDING #1545).
|
|
46
|
+
name: my-knowledge-base
|
|
47
|
+
services:
|
|
48
|
+
web:
|
|
49
|
+
type: nextjs
|
|
50
|
+
path: /
|
|
51
|
+
needs:
|
|
52
|
+
ai: true
|
|
53
|
+
database: true
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
> **Capability:** `needs: { database: true }` → the deployer provisions Mongo and
|
|
57
|
+
> injects `DATABASE_MONGODB_URL` (plus legacy `MONGODB_URL`). `needs: { ai: true }`
|
|
58
|
+
> → injects `AI_GATEWAY_URL`; `@cloudgrid-io/ai` routes embeddings + chat through
|
|
59
|
+
> it with no API key to manage. `needs: { vector: pgvector }` (would inject
|
|
60
|
+
> `VECTOR_PGVECTOR_URL`) is PENDING #1545. See the capability-map for the full
|
|
61
|
+
> injection table.
|
|
62
|
+
|
|
63
|
+
## Structure guide
|
|
64
|
+
|
|
65
|
+
The real content of this blueprint is **`AGENTS.md`** — fetch the template bundle
|
|
66
|
+
and read it. It covers the `services/web/` file tree, the `documents` / `chunks`
|
|
67
|
+
collections, the CloudGrid injection table (needs + AI Gateway + the #1545 note),
|
|
68
|
+
the ingest → retrieve → answer RAG loop with lazy `lib/db.js` / `lib/ai.js` /
|
|
69
|
+
`lib/retrieve.js`, optional auth/payments via `vault:`, and the
|
|
70
|
+
`grid init → fill → grid plug → poll` deploy flow.
|
|
71
|
+
|
|
72
|
+
## Adapt it
|
|
73
|
+
|
|
74
|
+
- Pick your chunking window/overlap and embedding model in `lib/chunk.js` /
|
|
75
|
+
`lib/ai.js`; tune retrieval `k`.
|
|
76
|
+
- Add auth (uncomment `vault: { AUTH_PROVIDER_KEY }`) to gate the KB, or payments
|
|
77
|
+
(`vault: { STRIPE_KEY }`) to charge for access.
|
|
78
|
+
- When pgvector #1545 lands, uncomment `needs: { vector: pgvector }` and swap
|
|
79
|
+
`lib/retrieve.js` to an ORDER-BY-distance query (`AGENTS.md` §7).
|
|
80
|
+
- Build under `services/web/`, then `grid dev` (local) / `grid plug` (async — poll
|
|
81
|
+
to a live URL).
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# analytics-dashboard template — Next.js + Mongo usage analytics
|
|
2
|
+
|
|
3
|
+
A minimal but real, deployable analytics dashboard. It stores **events**
|
|
4
|
+
(`{ type, value, at }`) in the grid-shared MongoDB, computes usage metrics
|
|
5
|
+
(total count, total value, distinct types, top type) plus a recent-events table,
|
|
6
|
+
and records new events via a POST. Data persists across refresh and is shared
|
|
7
|
+
across users/sessions — unlike a static page whose state is in memory only.
|
|
8
|
+
|
|
9
|
+
## How the grid gives you a database
|
|
10
|
+
|
|
11
|
+
You do **not** provision a database or set a connection string. In
|
|
12
|
+
`cloudgrid.yaml` you declare `needs: { database: true }`, and the grid:
|
|
13
|
+
|
|
14
|
+
- provisions shared Mongo for the app, and
|
|
15
|
+
- injects the connection string as the **`DATABASE_MONGODB_URL`** environment
|
|
16
|
+
variable (plus the legacy `MONGODB_URL` alias) — at dev-time (`grid dev`) and
|
|
17
|
+
at runtime (after `grid plug`).
|
|
18
|
+
|
|
19
|
+
The app reads it via `process.env.DATABASE_MONGODB_URL` (with a legacy
|
|
20
|
+
`process.env.MONGODB_URL` fallback) in `services/web/lib/db.js` — **lazily,
|
|
21
|
+
inside the `getDb` getter, never at module top level** (a top-level read fails
|
|
22
|
+
`next build`, which imports the module for route analysis before the grid injects
|
|
23
|
+
the var). Never hardcode a connection string; never commit a secret.
|
|
24
|
+
|
|
25
|
+
> **Declare `needs: { database: true }` (the canonical shape).** The deployer
|
|
26
|
+
> provisions Mongo and injects `DATABASE_MONGODB_URL` (plus the legacy
|
|
27
|
+
> `MONGODB_URL` alias). `requires:` is the deprecated v1 alias — don't author new
|
|
28
|
+
> yaml with it, and never set `needs:` and `requires:` together (the validator
|
|
29
|
+
> rejects the combination).
|
|
30
|
+
|
|
31
|
+
## The domain
|
|
32
|
+
|
|
33
|
+
An **event** document is `{ type: string, value: number, at: Date }`:
|
|
34
|
+
|
|
35
|
+
- `type` — what happened (e.g. `page_view`, `signup`, `purchase`).
|
|
36
|
+
- `value` — a numeric measure (a count of 1, a dollar amount, a duration…).
|
|
37
|
+
- `at` — the server timestamp, set on insert.
|
|
38
|
+
|
|
39
|
+
The dashboard reads the collection server-side and shows: **total event count**,
|
|
40
|
+
**total value (sum)**, **distinct event types**, **top type by value**, and a
|
|
41
|
+
**recent-events table**. The form POSTs a new event.
|
|
42
|
+
|
|
43
|
+
## Service layout
|
|
44
|
+
|
|
45
|
+
App code lives under **`services/web/`**, not the template root. `path:` in
|
|
46
|
+
`cloudgrid.yaml` is the URL mount, not the filesystem path — the service named
|
|
47
|
+
`web` means the CLI looks for `services/web/`. Files at the root fail with
|
|
48
|
+
`Error: Service directory not found: …/services/web`.
|
|
49
|
+
|
|
50
|
+
## Run locally
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npm install
|
|
54
|
+
grid dev # runs Next.js with DATABASE_MONGODB_URL injected against dev Mongo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Deploy
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
grid plug # builds + deploys the folder (async — poll status until live)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
A runtime deploy is asynchronous: `plug` returns `status: building`; poll status
|
|
64
|
+
until the app is live, then use the returned live URL. Re-plug the same entity
|
|
65
|
+
to update the same URL.
|
|
66
|
+
|
|
67
|
+
## File tree
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
cloudgrid.yaml # name + services.web (nextjs) + needs: { database: true }
|
|
71
|
+
services/web/package.json # next, react, react-dom, mongodb driver only
|
|
72
|
+
services/web/lib/db.js # lazy Mongo client from DATABASE_MONGODB_URL (legacy MONGODB_URL fallback)
|
|
73
|
+
services/web/app/layout.js # root layout + inline CSS
|
|
74
|
+
services/web/app/page.js # server component: reads events, computes counts/sums
|
|
75
|
+
services/web/app/event-form.js # client form + recent-events table: POST/DELETE via the API
|
|
76
|
+
services/web/app/api/events/route.js # GET (list) / POST (record) / DELETE (remove)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Adapt it
|
|
80
|
+
|
|
81
|
+
- Rename the `events` collection in `services/web/app/api/events/route.js` and
|
|
82
|
+
`services/web/app/page.js`.
|
|
83
|
+
- Change the document fields (add a `source`, a `userId`, tags).
|
|
84
|
+
- Add more aggregations (per-day buckets, per-type breakdown) in `summarize`.
|
|
85
|
+
- Add `cache: true` to `needs:` only if you actually need Redis.
|
|
@@ -0,0 +1,232 @@
|
|
|
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: analytics-dashboard
|
|
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
|
+
# vault:
|
|
122
|
+
# STRIPE_KEY: stripe-live-key
|
|
123
|
+
# SENDGRID_API_KEY: sendgrid-key
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
# ─── CONNECTORS AND HOOKS ──────────────────────────────────────────────────
|
|
127
|
+
|
|
128
|
+
# connectors:
|
|
129
|
+
# - id: team-slack
|
|
130
|
+
# target: org # 'system' | 'org'.
|
|
131
|
+
# channel: "#deploys"
|
|
132
|
+
# hooks:
|
|
133
|
+
# - on: deploy.failed # release.published | deploy.failed | feedback.received | entity.created
|
|
134
|
+
# via: team-slack
|
|
135
|
+
# template: "Deploy failed for {entity_name}: {error}"
|
|
136
|
+
# channel: "#alerts"
|
|
137
|
+
# triggers:
|
|
138
|
+
# - from: team-slack
|
|
139
|
+
# event: message
|
|
140
|
+
# channel: "#support"
|
|
141
|
+
# route: /webhooks/slack
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
# ─── LOCAL DEVELOPMENT ──────────────────────────────────────────────────────
|
|
145
|
+
|
|
146
|
+
# Config for `grid dev`. Redact fields in dev data snapshots.
|
|
147
|
+
# dev:
|
|
148
|
+
# snapshot:
|
|
149
|
+
# mask:
|
|
150
|
+
# - users.email
|
|
151
|
+
# - users.phone
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
# ─── AGENT METADATA ────────────────────────────────────────────────────────
|
|
155
|
+
|
|
156
|
+
# An agent is an app with kind: agent (above) and an agent: block.
|
|
157
|
+
# agent:
|
|
158
|
+
# purpose: Sync customer data from external CRM every night
|
|
159
|
+
# schedule: "0 2 * * *"
|
|
160
|
+
# trigger: webhook
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
# ─── PRIVATE RESOURCE AUTO-DEPENDENCIES ────────────────────────────────────
|
|
164
|
+
|
|
165
|
+
# When true (default), private resources are auto-injected as depends_on.
|
|
166
|
+
# auto_depends_on_private_requires: true
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
# ─── SERVICES (REQUIRED) ───────────────────────────────────────────────────
|
|
170
|
+
#
|
|
171
|
+
# At least one service is required. Key = service name (slug rules).
|
|
172
|
+
# Types: node, nextjs, python, static, cron.
|
|
173
|
+
#
|
|
174
|
+
services:
|
|
175
|
+
web:
|
|
176
|
+
# type (REQUIRED): node | nextjs | python | static | cron
|
|
177
|
+
type: nextjs
|
|
178
|
+
# HTTP route: '/' | '/api' | false (internal) | omitted (=false + warning).
|
|
179
|
+
# Only one service per entity can claim '/'.
|
|
180
|
+
path: /
|
|
181
|
+
# Container port (default 8080; read process.env.PORT). Not for cron.
|
|
182
|
+
# port: 3000
|
|
183
|
+
# nextjs only: base_image: distroless (default) | alpine
|
|
184
|
+
# base_image: distroless
|
|
185
|
+
# node only: lang: javascript (default) | typescript
|
|
186
|
+
# lang: typescript
|
|
187
|
+
# Custom source location (default services/<name>/). '.' = project root.
|
|
188
|
+
# source:
|
|
189
|
+
# path: src/worker
|
|
190
|
+
# Health probe: false/omitted (TCP) | true (/health) | "/path" | {path,expected}
|
|
191
|
+
# health:
|
|
192
|
+
# path: /api/health
|
|
193
|
+
# expected: "200"
|
|
194
|
+
# Static runtime env vars (strings). Reserved: PORT, APP_NAME, SERVICE_NAME,
|
|
195
|
+
# NODE_ENV, MONGODB_URL, REDIS_URL, AI_GATEWAY_URL, N8N_WEBHOOK_URL, CLOUDGRID_*.
|
|
196
|
+
# env:
|
|
197
|
+
# LOG_LEVEL: info
|
|
198
|
+
# Sibling services/private resources that must be Ready first (no cron, no cycles).
|
|
199
|
+
# depends_on:
|
|
200
|
+
# - worker
|
|
201
|
+
# Per-service needs override (merges with app-level needs).
|
|
202
|
+
# needs:
|
|
203
|
+
# queue: true
|
|
204
|
+
# Static-only build step:
|
|
205
|
+
# build:
|
|
206
|
+
# command: npm run build
|
|
207
|
+
# output: dist
|
|
208
|
+
# env:
|
|
209
|
+
# VITE_API_URL: https://api.example.com
|
|
210
|
+
# node_version: "22" # static build step: '18'|'20'|'22'|'24' (quoted)
|
|
211
|
+
# Cron-only: schedule (REQUIRED), timezone (UTC|EST|PST), run (job | https URL)
|
|
212
|
+
# schedule: "0 9 * * 1"
|
|
213
|
+
# timezone: UTC
|
|
214
|
+
# run: job
|
|
215
|
+
# Verbose per-service persistence (prefer needs.disk):
|
|
216
|
+
# persist:
|
|
217
|
+
# - name: scratch
|
|
218
|
+
# path: /tmp/scratch
|
|
219
|
+
# size: 500Mi
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
needs:
|
|
223
|
+
database: true
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
# ============================================================================
|
|
227
|
+
# NOTES
|
|
228
|
+
# - NOT here: org:/entity_id: (→ .cloudgrid/link.json), secrets (→ grid secrets set),
|
|
229
|
+
# Dockerfile (platform generates from services.*.type).
|
|
230
|
+
# - Deploy: grid plug | Local with grid resources: grid dev
|
|
231
|
+
# - Full reference: docs/cloudgrid-yaml-reference.md | CLI: docs/cli-reference.md
|
|
232
|
+
# ============================================================================
|