MIE Web Open Source Template

Shared baseline files for MIE Web open source projects — Copilot instructions, .gitignore, and more.

Apply to an Existing Project

Option 1 — curl one-liner

bash <(curl -sL https://raw.githubusercontent.com/mieweb/template-mieweb-opensource/main/apply.sh)

Option 2 — npx (Node.js 18+)

The npx support lives on the npx branch to keep main clean as a template.

npx github:mieweb/template-mieweb-opensource#npx

What it does

1. Fetches each template file from this repo
2. Checks if it already exists in your project
3. If it doesn't exist → prompts to create or skip
4. If it exists but differs → prompts to:
   • (o)verwrite — replace with the template version
   • (a)ppend — add the template content at the end
   • (m)erge — deduplicate lines (great for .gitignore)
   • (s)kip — leave your file untouched
5. If it's already identical → skips automatically

Template files included

File	Purpose
.github/copilot-instructions.md	Code quality, accessibility, i18n, docs standards for GitHub Copilot
.gitignore	Standard ignores for Node.js projects

Adding new template files

Edit the TEMPLATE_FILES array in:

• apply.sh (shell script — always on main)
• bin/apply-template.mjs (Node.js CLI — on the npx branch)

Starting a new project

1. Use this repo as a GitHub template
2. Replace this README with your own — consider Working Backwards
3. Use npx create to scaffold your framework
4. Use API-first thinking (no UI-first)

MIE Web UI (HTML projects only)

If your project is an HTML project with a UI, consider using the MIE Web UI component library:

npm install @mieweb/ui
# or
yarn add @mieweb/ui
# or
pnpm add @mieweb/ui

Note: This only applies to HTML/UI projects. If your project is Python, a pure API, or another non-UI stack, skip this step.