A Copier template that scaffolds an Astro project with strict TypeScript, Vitest, and Prettier. Run copier to generate a new project, then npm install && npm test.
  • Python 83.8%
  • Jinja 7.4%
  • Astro 4.3%
  • TypeScript 2.3%
  • JavaScript 1.8%
  • Other 0.4%
Find a file
ses fdc7546788
All checks were successful
Tests / Lint (push) Successful in 7s
Tests / Test (push) Successful in 2m6s
revert 1caa28cb48
revert docs: fix pipx usage - use install instead of pipx run
2026-06-26 18:19:31 +00:00
.forgejo/workflows ci: add Forgejo workflow and ruff, exclude from generated template 2026-06-26 11:15:18 +00:00
tests test: add workflow integration test and share test constants 2026-06-26 14:26:26 +00:00
{{package_name}} test: add workflow integration test and share test constants 2026-06-26 14:26:26 +00:00
.devcontainer.json feat: scaffold Astro Hello World copier template 2026-06-26 09:49:43 +00:00
.gitignore ci: add Forgejo workflow and ruff, exclude from generated template 2026-06-26 11:15:18 +00:00
AGENTS.md ci: add Forgejo workflow and ruff, exclude from generated template 2026-06-26 11:15:18 +00:00
copier.yml fix(copier): guard npm install task against copier update 2026-06-26 16:03:20 +00:00
Makefile chore: exclude Python tooling from generated Astro template 2026-06-26 10:56:25 +00:00
pyproject.toml ci: add Forgejo workflow and ruff, exclude from generated template 2026-06-26 11:15:18 +00:00
README.md revert 1caa28cb48 2026-06-26 18:19:31 +00:00
uv.lock ci: add Forgejo workflow and ruff, exclude from generated template 2026-06-26 11:15:18 +00:00

Astro Hello World Copier Template

A modern, minimal Astro 5 project template scaffolded with Copier. Perfect for developers new to Copier or looking for a well-configured Astro + TypeScript starter.

Features: Strict TypeScript, Vitest testing, Prettier formatting, CI/CD workflows, DevContainer support, and zero manual setup—everything runs automatically after generation.

Quick Start

Prerequisites

  • Python 3.13+ (required for Copier template tooling)
  • Node.js 22.12.0+ (required for generated Astro projects)

Generate Your Project

Option A: Using uvx (Recommended)

Install uv first, then:

uvx copier copy --trust https://github.com/your-org/templates /path/to/output
cd /path/to/output/my-astro-app  # or your chosen project name
npm run dev

Option B: Using pipx (Alternative)

If you prefer pipx:

pipx run copier copy --trust https://github.com/your-org/templates /path/to/output
cd /path/to/output/my-astro-app
npm run dev

Tip

The --trust flag is required because this template uses post-render tasks (automated setup). See Copier docs for details.

After Generation

Copier automatically:

  • ✓ Initializes a git repository
  • ✓ Installs npm dependencies
  • ✓ Creates an initial commit

You're ready to start coding immediately:

npm run dev          # Start dev server (Astro)
npm run type-check   # Type checking with astro check
npm test             # Run tests (Vitest)
npm run format       # Auto-format code with Prettier
npm run build        # Production build
npm run pre-commit   # Run all checks before committing

Visit http://localhost:3000 to see your project.

Customization Tips

Add a New Page

Create a new .astro file in src/pages/:

---
// src/pages/about.astro
---

<h1>About Me</h1>
<p>Welcome to my Astro site.</p>

Astro automatically creates routes based on file names. See the Astro routing guide.

Deploy Your Project

Astro deploys seamlessly to Netlify, Vercel, GitHub Pages, and more. See the Astro deployment guide for detailed instructions.

Learn More