From 3e4c02d5144a0380703bef0906dd431c10c4ea6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roch=C3=A9=20Compaan?= Date: Tue, 17 Feb 2026 18:07:32 +0200 Subject: [PATCH 1/2] From e6ce58ed5f47809ae5463988f12735d82f2e2e21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roch=C3=A9=20Compaan?= Date: Tue, 17 Feb 2026 18:08:26 +0200 Subject: [PATCH 2/2] chore: update README.md --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/README.md b/README.md index 4ea5bfc..96f1303 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,65 @@ getscaf Welcome to the getscaf organization πŸ—οΈ β€” the home of Scaf and its ecosystem of project templates and tooling that help developers scaffold, build and evolve modern applications efficiently. + +🌟 What is Scaf? + +Scaf is a CLI-based template manager that simplifies project creation and +ongoing project updates. With a single command, Scaf can: + +🎨 Bootstrap a new project from a GitHub template + +πŸ”„ Update existing projects created from supported templates + +πŸ“¦ Support any GitHub-hosted template or local path + +βš™οΈ Offer advanced options for defaults and version selection + +It ships with batteries for both Linux and macOS users and also offers Nix +support for reproducible local environments. + +πŸ“¦ Organization Contents + +This org hosts repositories related to the Scaf ecosystem. Notable repos +include: + +πŸ› οΈ scaf + +The core CLI tool and manager that: + +Installs and runs templates from any GitHub repo + +Updates existing scoped projects + +Offers options for default answers and versioned template selection + +Highlights: + +πŸƒ Simplifies bootstrapping and updating projects + +🧰 Supports custom templates via GitHub URL or local path + +πŸ” Template choices include full-stack and AWS Lambda starters + +πŸ“œ BSD-3-Clause license πŸ“₯ + +πŸ“˜ scaf-fullstack-template (or similar) + +A comprehensive full-stack project template (often used with Scaf): + +🐍 Backend: Django app with production settings + +βš›οΈ Frontend: Optional Next.js or React integration + +🐘 PostgreSQL (with CloudNativePG for prod) + +🧠 Redis for caching and message brokering + +πŸ“¦ Infra: Kubernetes manifests, Terraform bits, ArgoCD configs + +πŸ§ͺ Dev tooling: GitHub Actions CI/CD, Tilt, Kind, Prometheus, Grafana + +πŸ“‘ Automated semantic-release driven versioning + +Note: The template repo structure and docs may evolve; check each template’s own +README for exact usage details.