Skip to content

Rebranding & updates

Because the repository is a Copier template, rebranding is not a fragile find-and-replace script — it is the generation step itself. And you can pull upstream template improvements into an already-generated project.

Generate (rebrand)

uvx copier copy gh:ravipurohit1991/OpenProductKit my-product

You are prompted for:

Question Used for
project_name Titles, docs, UI heading
project_slug Directories, npm/docker names
pkg_slug Python package names (<pkg>_core, …)
cli_name The CLI entrypoint (default opk)
project_description, author_name, author_email Metadata
python_version requires-python and targets

Everything — package names, imports, the desktop bundle id (later), README, .env.example, Docker image names — is rendered from these answers.

Brand assets

OpenProductKit's source docs keep the reusable project marks in docs/assets/brand/.

Asset Preview Use
openproductkit-banner.svg OpenProductKit banner Wide README and docs hero placements
openproductkit-logo.svg OpenProductKit wordmark Wide headers, presentations and brand references
openproductkit-favicon.svg OpenProductKit favicon Browser favicon and compact docs navigation logo

Update

Copier records your answers in .copier-answers.yml. To pull in later template improvements:

copier update

Copier performs a three-way merge between the template version you generated from, the latest template, and your local changes — so your customizations survive. This is the entire "keep generated projects up to date" story, for free.

Tip

Commit your generated project to git before running copier update so the merge is reviewable as a normal diff.

Updating after you've replaced the demo

Once you have replaced the Resource Vault demo with your own domain, expect two kinds of files during copier update:

  • Framework files you never touched (licensing, plugin system, desktop shell, CLI control plane, CI) merge cleanly — this is where upstream improvements keep flowing in.
  • Demo files you rewrote or deleted will conflict or reappear. That is expected: you replaced them on purpose. Resolve in favor of your version — keep your files, delete resurrected demo files. The demo is a scaffold, not a maintained surface.