FLUX DOCUMENTATION SYSTEM Layer 11 — STARTER KIT | starter-kit-template-plan flux.dantesisofo.com/wiki/starter-kit-template-plan/
The exact contents of the eventual student package. The kit is the geotag walk → static project page → master hub/map + private portal slice — and nothing else.
The geotag publishing pipeline, which is well-factored and largely path-relative:
submission.json.s3 sync + CloudFront-invalidation helper.requirements.txt — pinned.These stay private; they are not needed to teach the geotag publisher and are specific to the author's larger practice:
sample_walk/ of 6–12 redistributable geotagged JPEGs (CC0/public-domain),
or a small script that synthesizes EXIF+GPS onto sample images.{ "schema_version": "...", "walks": [], "reserved_slugs": [] }.examples/ folder with one reference published project + hub so students
can see expected output before running their own.A committed template with placeholders only (the real .env is gitignored).
It documents: FLUX_BUCKET, FLUX_CF_DIST, FLUX_REGION, FLUX_BASE_URL,
FLUX_AUTHOR, the PORTAL_* local-auth vars, and the optional
ANTHROPIC_API_KEY + MAIL_SMTP_*. See STUDENT SETUP for
the full block.
| File | Purpose |
|---|---|
README.md |
What it is, architecture diagram, quickstart |
SETUP_AWS.md |
IAM least-privilege policy, S3 bucket, CloudFront + OAC |
RUN_LOCAL.md |
Python/venv, run the portal, the studio workflow |
PUBLISH_PROJECT.md |
create → upload → generate → publish; hub auto-update; iframe embed |
CONFIGURATION.md |
every env var; the canonical-naming rule; the collection/hub concept |
TROUBLESHOOTING.md |
credentials errors, slow vs stuck generation, CloudFront cache, restart-after-edit, single-portal rule |
(These wiki pages are the source material; the kit's standalone docs are derived from them.)
Sanitizing isn't deletion — it's parameterization. The build step replaces the
hardcoded bucket / distribution / domain / region / author / home-path values
(spread across the working code) with reads from one config module backed by
.env. This is the bulk of turning the working system into a template.
cityflux-starter/
README.md SETUP_AWS.md RUN_LOCAL.md PUBLISH_PROJECT.md
CONFIGURATION.md TROUBLESHOOTING.md
requirements.txt .env.example .gitignore
flux/ # config + canonical naming + cli
worker/ # draft generation pipeline
publisher/ # project page + hub + embed + catalog + deploy
portal/ # private Flask studio (app + blueprint + templates)
zine/ # client-side PDF + vendored libs
data/catalog.seed.json
sample_walk/ # redistributable geotagged photos
examples/ # one reference project + hub
Next: ROADMAP for how this gets released.
FLUX_WIKI_v2.0 — flux.dantesisofo.com/wiki/starter-kit-template-plan/