From 1676dc22dfc62a4584e4896732a99b951bfb2fe2 Mon Sep 17 00:00:00 2001 From: SaelixCode Date: Wed, 4 Mar 2026 14:26:07 -0500 Subject: [PATCH] feat: implement app templates storefront and deployment engine --- CHANGELOG.md | 1 + backend/package-lock.json | 132 +++++++++++ backend/package.json | 3 +- backend/src/index.ts | 46 ++++ backend/src/services/TemplateService.ts | 106 +++++++++ frontend/src/components/EditorLayout.tsx | 19 +- frontend/src/components/TemplatesView.tsx | 270 ++++++++++++++++++++++ 7 files changed, 574 insertions(+), 3 deletions(-) create mode 100644 backend/src/services/TemplateService.ts create mode 100644 frontend/src/components/TemplatesView.tsx diff --git a/CHANGELOG.md b/CHANGELOG.md index b9716e88..8f519f0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,3 +8,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Git Flow branching strategy and branch protection. - GitHub Actions CI pipeline for automated TypeScript build verification. +- **Added:** App Templates (App Store) with One-Click deployment, utilizing Portainer v2 JSON registries and auto-generating compose files. diff --git a/backend/package-lock.json b/backend/package-lock.json index 1e2dee12..0f543f2b 100644 --- a/backend/package-lock.json +++ b/backend/package-lock.json @@ -13,6 +13,7 @@ "@types/dockerode": "^4.0.1", "@types/express": "^5.0.6", "@types/ws": "^8.18.1", + "axios": "^1.13.6", "bcrypt": "^6.0.0", "better-sqlite3": "^12.6.2", "composerize": "^1.7.5", @@ -566,6 +567,23 @@ "safer-buffer": "~2.1.0" } }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", + "license": "MIT" + }, + "node_modules/axios": { + "version": "1.13.6", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.13.6.tgz", + "integrity": "sha512-ChTCHMouEe2kn713WHbQGcuYrr6fXTBiu460OTwWrWob16g1bXn4vtz07Ope7ewMozJAnEquLk5lWQWtBig9DQ==", + "license": "MIT", + "dependencies": { + "follow-redirects": "^1.15.11", + "form-data": "^4.0.5", + "proxy-from-env": "^1.1.0" + } + }, "node_modules/balanced-match": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.3.tgz", @@ -865,6 +883,18 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "license": "MIT" }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "license": "MIT", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/composerize": { "version": "1.7.5", "resolved": "https://registry.npmjs.org/composerize/-/composerize-1.7.5.tgz", @@ -1067,6 +1097,15 @@ "node": ">=0.10.0" } }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -1211,6 +1250,21 @@ "node": ">= 0.4" } }, + "node_modules/es-set-tostringtag": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", + "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.6", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", @@ -1349,6 +1403,63 @@ "url": "https://opencollective.com/express" } }, + "node_modules/follow-redirects": { + "version": "1.15.11", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", + "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/form-data": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.5.tgz", + "integrity": "sha512-8RipRLol37bNs2bhoV67fiTEvdTrbMUYcFTiy3+wuuOnUog2QBHCZWXDRijWQfAkhBj2Uf5UnVaiWwA5vdd82w==", + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "es-set-tostringtag": "^2.1.0", + "hasown": "^2.0.2", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/form-data/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/form-data/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/forwarded": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", @@ -1496,6 +1607,21 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/hasown": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", @@ -2141,6 +2267,12 @@ "node": ">= 0.10" } }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", + "license": "MIT" + }, "node_modules/pstree.remy": { "version": "1.1.8", "resolved": "https://registry.npmjs.org/pstree.remy/-/pstree.remy-1.1.8.tgz", diff --git a/backend/package.json b/backend/package.json index e2795079..b323ee98 100644 --- a/backend/package.json +++ b/backend/package.json @@ -29,6 +29,7 @@ "@types/dockerode": "^4.0.1", "@types/express": "^5.0.6", "@types/ws": "^8.18.1", + "axios": "^1.13.6", "bcrypt": "^6.0.0", "better-sqlite3": "^12.6.2", "composerize": "^1.7.5", @@ -42,4 +43,4 @@ "ws": "^8.19.0", "yaml": "^2.8.2" } -} \ No newline at end of file +} diff --git a/backend/src/index.ts b/backend/src/index.ts index 650cf525..faaef917 100644 --- a/backend/src/index.ts +++ b/backend/src/index.ts @@ -19,6 +19,7 @@ import { HostTerminalService } from './services/HostTerminalService'; import { DatabaseService } from './services/DatabaseService'; import { NotificationService } from './services/NotificationService'; import { MonitorService } from './services/MonitorService'; +import { templateService } from './services/TemplateService'; import YAML from 'yaml'; import { promises as fsPromises } from 'fs'; @@ -1048,6 +1049,51 @@ app.post('/api/system/networks/delete', async (req: Request, res: Response) => { } }); +// --- App Templates Routes --- + +app.get('/api/templates', async (req: Request, res: Response) => { + try { + const templates = await templateService.getTemplates(); + res.json(templates); + } catch (error) { + res.status(500).json({ error: 'Failed to fetch templates' }); + } +}); + +app.post('/api/templates/deploy', async (req: Request, res: Response) => { + try { + const { stackName, template, envVars } = req.body; + + if (!stackName || !template) { + return res.status(400).json({ error: 'stackName and template are required' }); + } + + // 1. Create stack directory + await fileSystemService.createStack(stackName); + + // 2. Generate compose YAML and save + const composeYaml = templateService.generateComposeFromTemplate(template); + await fileSystemService.saveStackContent(stackName, composeYaml); + + // 3. Generate env string and save to default .env + if (envVars) { + const envString = templateService.generateEnvString(envVars); + const stackDir = path.join(fileSystemService.getBaseDir(), stackName); + const defaultEnvPath = path.join(stackDir, '.env'); + await fsPromises.writeFile(defaultEnvPath, envString, 'utf-8'); + } + + // 4. Deploy the stack + await composeService.deployStack(stackName, terminalWs || undefined); + + res.json({ success: true, message: 'Template deployed successfully' }); + } catch (error: any) { + console.error('Failed to deploy template:', error); + res.status(500).json({ error: error.message || 'Failed to deploy template' }); + } +}); + + // Serve static files in production (for Docker deployment) if (process.env.NODE_ENV === 'production') { diff --git a/backend/src/services/TemplateService.ts b/backend/src/services/TemplateService.ts new file mode 100644 index 00000000..2769520f --- /dev/null +++ b/backend/src/services/TemplateService.ts @@ -0,0 +1,106 @@ +import axios from 'axios'; + +export interface TemplateEnv { + name: string; + label?: string; + default?: string; +} + +export interface TemplateVolume { + container: string; + bind?: string; + readonly?: boolean; +} + +export interface Template { + type?: number; + title: string; + description: string; + logo?: string; + image?: string; + ports?: string[]; + volumes?: TemplateVolume[] | string[]; + env?: TemplateEnv[]; + categories?: string[]; + platform?: string; + repository?: { + url: string; + stackfile: string; + }; +} + +export interface TemplatesResponse { + version: string; + templates: Template[]; +} + +export class TemplateService { + private cachedTemplates: Template[] = []; + private lastFetchTime: number = 0; + private readonly CACHE_DURATION_MS = 24 * 60 * 60 * 1000; // 24 hours + private readonly TEMPLATES_URL = 'https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json'; + + public async getTemplates(): Promise { + const now = Date.now(); + if (this.cachedTemplates.length > 0 && now - this.lastFetchTime < this.CACHE_DURATION_MS) { + return this.cachedTemplates; + } + + try { + const response = await axios.get(this.TEMPLATES_URL); + // Filter out templates without images as we are generating compose files from image, ports, etc. + this.cachedTemplates = (response.data.templates || []).filter((t: Template) => !!t.image && t.type === 1); + this.lastFetchTime = now; + return this.cachedTemplates; + } catch (error) { + console.error('Failed to fetch templates', error); + if (this.cachedTemplates.length > 0) { + return this.cachedTemplates; + } + throw new Error('Could not fetch templates from registry'); + } + } + + public generateComposeFromTemplate(template: Template): string { + let yaml = `services:\n app:\n`; + + if (template.image) { + yaml += ` image: ${template.image}\n`; + } + + yaml += ` restart: unless-stopped\n`; + + if (template.ports && template.ports.length > 0) { + yaml += ` ports:\n`; + for (const port of template.ports) { + yaml += ` - "${port}"\n`; + } + } + + if (template.volumes && template.volumes.length > 0) { + yaml += ` volumes:\n`; + for (const vol of template.volumes) { + if (typeof vol === 'string') { + yaml += ` - ${vol}\n`; + } else if (vol.container) { + // If bind is not provided, we extract the folder name from the container path + const containerFolder = vol.container.split('/').pop() || 'data'; + const localBind = vol.bind ? vol.bind.replace(/^\//, './') : `./${containerFolder}`; + yaml += ` - ${localBind}:${vol.container}${vol.readonly ? ':ro' : ''}\n`; + } + } + } + + yaml += ` env_file:\n - .env\n`; + + return yaml; + } + + public generateEnvString(envVars: Record): string { + return Object.entries(envVars) + .map(([key, value]) => `${key}=${value}`) + .join('\n'); + } +} + +export const templateService = new TemplateService(); diff --git a/frontend/src/components/EditorLayout.tsx b/frontend/src/components/EditorLayout.tsx index ea348909..b7ac23c7 100644 --- a/frontend/src/components/EditorLayout.tsx +++ b/frontend/src/components/EditorLayout.tsx @@ -28,6 +28,8 @@ import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigge import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/components/ui/select'; import { SettingsModal } from './SettingsModal'; import { StackAlertSheet } from './StackAlertSheet'; +import { TemplatesView } from './TemplatesView'; + interface ContainerInfo { Id: string; Names: string[]; @@ -76,7 +78,7 @@ export default function EditorLayout() { } return true; // Default to dark mode }); - const [activeView, setActiveView] = useState<'dashboard' | 'editor' | 'host-console' | 'resources'>('dashboard'); + const [activeView, setActiveView] = useState<'dashboard' | 'editor' | 'host-console' | 'resources' | 'templates'>('dashboard'); const [isEditing, setIsEditing] = useState(false); const [searchQuery, setSearchQuery] = useState(''); const [stackStatuses, setStackStatuses] = useState({}); @@ -765,6 +767,17 @@ export default function EditorLayout() { Resources + {/* Templates Toggle */} + {/* Settings Modal Toggle */}