diff --git a/docs/features/app-store.mdx b/docs/features/app-store.mdx index d128bd31..f43f72bb 100644 --- a/docs/features/app-store.mdx +++ b/docs/features/app-store.mdx @@ -1,107 +1,155 @@ --- title: App Store -description: Browse and deploy pre-configured application templates in one click. +description: Browse a curated catalogue of Docker Compose templates and deploy any of them as a new stack with one click. --- -The **App Store** tab lets you browse a curated catalogue of Docker Compose templates and deploy any of them as a new stack with environment-specific configuration, no YAML required. +The **App Store** is a browseable catalogue of Docker Compose templates. Each template is a turn-key recipe with sensible defaults for ports, volumes, and environment variables, so you can stand up a new stack without writing YAML. Pick a tile, fill in a name, click **Deploy** and Sencho creates the directory, generates `compose.yaml` and `.env`, runs `docker compose up -d`, and switches you to the editor for the new stack. - App Store with a category sidebar, a featured template hero banner, and editorial tiles with security scan badges + App Store with the categories rail on the left, a featured template hero pinned at the top, and a grid of editorial tiles with per-tile scan badges ## Browsing templates -Templates are loaded from a remote registry (configurable in **Settings > App Store**). The default registry is LinuxServer.io. A live count of available apps is shown in the top right of the view. +Templates load from a remote registry. The default registry is **LinuxServer.io**; you can point Sencho at any [Portainer v2 compatible JSON catalogue](#custom-template-registry) instead. -**Search:** Type in the search bar to filter templates by name, description, or category in real-time. +### Search and counts -**Category sidebar:** The left rail lists every category with its count. Click a category to narrow the grid. The active category is highlighted with a cyan rail and tinted background. +The search bar at the top filters tiles by name, description, or category in real time. The chip on the right shows the number of templates currently visible (for example, `201 apps`). -**Featured hero:** A featured template is pinned at the top of the grid with its logo, title, description, and a primary **Deploy** button. The hero disappears while you have an active search query. +### Categories rail + +The left rail lists every category the registry exposes, plus an **All** entry, with a count for each. The active category gets a brand-coloured rail and tinted background. The rail appears once at least one template has loaded. + +### Featured template + +A single template is pinned to the top of the grid in a wide editorial banner. Sencho rotates the featured pick **weekly** through the five most-starred templates in the registry, so the catalogue stays fresh without you doing anything. The banner disappears whenever you have a search query active. + +### Tiles Each tile shows: -- A brand-tinted logo square (falls back to the first letter of the template name) -- Name and first-sentence pitch -- GitHub star count and primary category -- A **security scan badge** on the right: `CLEAN` (no CVEs detected), `{n} CVE(s)` (amber, open vulnerabilities), or `UNSCANNED` (no scan recorded yet) + +- A brand-tinted logo (falls back to a generic icon when the registry has no artwork) +- The template name and the first sentence of its description +- A GitHub star count (when the registry provides one) +- The primary category +- A **scan badge** on the right, derived from Sencho's vulnerability scanner: + - **Clean** (no CVEs detected on the most recent scan) + - **{N} CVE** or **{N} CVEs** (the count of open vulnerabilities, in amber) + - **Unscanned** (no scan has been recorded for this image yet) + +Tiles are sorted by GitHub star count, descending. Click any tile to open the deployment sheet on the right. ## Deploying a template -Click any tile to open the **deployment sheet** on the right side of the screen. The sheet splits configuration into two tabs: **Essentials** for a fast one-click deploy and **Advanced** for full control over ports, volumes, and environment. +The deployment sheet slides in from the right. The header carries a breadcrumb (`App store ›