PHPackages jalendport/spark-craft - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. jalendport/spark-craft ActiveProject[Framework](/categories/framework) jalendport/spark-craft ====================== Craft CMS starter project 1.0.0-beta.2(1mo ago)1100BSDJavaScript Since Jul 25Pushed 2y ago2 watchersCompare [ Source](https://github.com/jalendport/spark-craft)[ Packagist](https://packagist.org/packages/jalendport/spark-craft)[ GitHub Sponsors](https://github.com/sponsors/jalendport)[ RSS](/packages/jalendport-spark-craft/feed)WikiDiscussions master Synced 2w ago READMEChangelog (4)Dependencies (16)Versions (6)Used By (0) [![Spark Craft](.github/icon.svg)](.github/icon.svg) Spark Craft =========== [](#spark-craft) *An opinionated Craft CMS 5 starter that boots to a working site, not a blank slate.* Every new Craft site starts with the same setup: wiring a local stack, configuring a bundler, structuring templates, picking plugins. Spark Craft is that baseline already built — a [Craft CMS 5](https://craftcms.com) boilerplate that a single `spark create` turns into a running, conventional site with a Dockerized local stack, a modern Vite frontend, and a Twig/Vue template skeleton. Features -------- [](#features) - **Craft CMS 5.10 on PHP 8.4** — with CKEditor, SEOMate, Expanded Singles, Empty Coalesce, and Typogrify bundled - **Full Docker stack** — MySQL, nginx, PHP-FPM, a queue worker, Redis, Mailpit, and a Node container running Vite; nothing to install on the host beyond Docker and the spark CLI - **spark-native workflow** — `spark up`, `spark craft`, `spark composer`, and `spark npm` drive the whole stack, with no `docker compose exec` incantations - **Modern frontend** — Vite 8, Vue 3.5 with auto-registered components, and Tailwind CSS 4 with CSS-first design tokens - **Template conventions** — a `_router.twig` dispatch pattern, parameterized components, and a layered `_layouts` / `_partials` / `_includes` structure from day one - **Deploys included** — GitHub Actions workflows for staging and production, built on reusable Spark composite actions Installation ------------ [](#installation) You'll need [Docker Desktop](https://www.docker.com/products/docker-desktop/) or a compatible engine for the local stack, plus the [spark CLI](https://github.com/jalendport/spark-cli): ``` brew install jalendport/tap/spark ``` Scaffold and start a project: ``` spark create craft my-site ``` Answer the prompts and you'll land on a running site at , with the control panel at [/admin](http://localhost:8000/admin). `spark create` downloads the boilerplate and asks for your project name once, threading it through the project — the npm package name, the composer description, and the site name Craft is installed with. It copies `.env.example.dev` to `.env`, swaps `composer.json.project` into place as your project's `composer.json`, initializes a fresh git repository, then asks to run setup. Confirm, and it brings the Docker stack up — dependencies install on first boot — and installs Craft together with the bundled plugins, prompting only for your admin account and site language (the site name and URL are set for you). Decline, and spark prints those commands so you can run them whenever you're ready. ### Without the spark CLI [](#without-the-spark-cli) Prefer plain Composer? `composer create-project` scaffolds the same project: ``` composer create-project jalendport/spark-craft my-site ``` Its `post-create-project-cmd` copies `.env` from `.env.example.dev`, swaps `composer.json.project` into place as your `composer.json`, and removes the interim lockfile. From there, wire up your own stack: 1. Configure `.env` for your environment — `APP_URL` must be set, since the installer reads it through the `@web` alias. 2. Run `composer install` to pull in Craft and the bundled plugins. 3. Run `composer craft-setup` to generate keys, install Craft, and enable the plugins — the installer prompts for your site name along with the admin account. Usage ----- [](#usage) ### Docker workflow [](#docker-workflow) `docker-compose.yml` defines the local services: ServiceImage / buildHost port`mysql``jalendport/spark-mysql``3307` → 3306`nginx``jalendport/spark-nginx``8000` → 80 (the site)`node`local build (Vite)`8080` (dev server)`php`local build (PHP-FPM)internal only`queue`local buildinternal only (queue worker)`redis``redis:7-alpine`internal only`mailpit``axllent/mailpit``8025` (web UI, overridable)`spark up` starts everything detached; `spark logs` tails the services and `spark down` stops them. The site is served at `http://localhost:8000`, the Vite dev server at `http://localhost:8080`, and Mailpit's inbox UI at `http://localhost:8025` (set `MAILPIT_UI_PORT` in `.env` when another project already claims 8025). On first boot the `node` container runs `npm install` for you. Keep it that way: Vite's bundler ships platform-native binaries, so a `node_modules/` installed from the macOS host won't run inside the Linux container. If you ever install on the host (e.g. for editor tooling), delete `node_modules/` and restart the `node` container to get a container-native install back. Run Craft console commands inside the `php` container: ``` spark craft ``` Scaffold Craft classes with the generator: ``` spark craft make --with-docblocks ``` The verbs come from two places: the project's `spark.yml` maps `spark craft`, `spark composer`, and `spark npm` into the right containers, and the CLI ships built-ins (`up`, `down`, `restart`, `logs`, `sh`, `run`) for the compose lifecycle. Run `spark` from the project root to see them all. ### Frontend [](#frontend) The frontend source lives in `src/`, and Vite is configured in `config/frontend/vite.config.js`. There are two entry points, `src/js/main.js` and `src/css/main.css`, injected into Twig via the [craft-vite](https://github.com/nystudio107/craft-vite) plugin (`craft.vite.script(...)` / `craft.vite.asset(...)`). Built assets land in `web/dist/`. npm scripts (run in the `node` container via `spark npm`): - `spark npm run dev` — start the Vite dev server (normally run for you by the `node` container) - `spark npm run build` — production build - `spark npm run preview` — preview a production build - `spark npm run svg` — optimize icons in `web/assets/icons/{16,20,24}` with SVGO ### Tailwind 4 [](#tailwind-4) Design tokens live in `src/css/theme.css` using Tailwind 4's CSS-first `@theme` block — there is no `tailwind.config.js`. Notable conventions: - **Semantic brand tokens.** `--color-brand-accent`, `--color-brand-heading`, `--color-brand-body`, and their `on-*` counterparts are placeholders meant to be swapped per project. Every colored background gets an `on-*` pair so contrast decisions live in the theme, not scattered across templates. - **1px spacing grid.** `--spacing` is set to `1px`, so utilities map directly to pixels (`p-20` is 20px, `text-16` is 16px). - **Fluid values** via [`tailwind-clamp`](https://nicolas-cusan.github.io/tailwind-clamp/), clamped between the `xs` and `2xl` breakpoints (e.g. `clamp-[text,34,48]`). ### Vue [](#vue) The Vue app auto-registers components from `src/js/vue/components/` using `import.meta.glob`: - `*.vue` files are registered eagerly. - `*.lazy.vue` files are registered as async components. An optional `*.loading.vue` and `*.error.vue` companion (matched by name) supply the loading and error states. Because the glob is evaluated at startup, a Vite plugin restarts the dev server when a component file is added or removed. The kit ships a set of form components (`FormInput`, `FormSelect`, `FormCheckbox`, `FormRadio`, `FormFileUpload`, etc.) and a `SuperForm` wrapper built on [vee-validate](https://vee-validate.logaflow.com/) and [yup](https://github.com/jquense/yup), plus composables in `src/js/vue/composables/` and framework-agnostic helpers in `src/js/utils/`. ### Icons and fonts [](#icons-and-fonts) - **Icons** are optimized SVGs in `web/assets/icons/{16,20,24}` (organized by pixel size) and rendered inline via Craft's `svg()` function — for example the `_components/button.twig` `leftIcon` / `rightIcon` params. - **Fonts** are self-hosted: drop `woff2` files into `web/assets/fonts/`, uncomment the `@font-face` blocks in `src/css/components/typography.css`, and point `--font-sans` / `--font-display` at the family in `theme.css`. ### Templates [](#templates) Templates live in `src/templates/` — the templates path is moved there by the `CRAFT_TEMPLATES_PATH` constant defined in `config/craft/bootstrap.php`. - **`_router.twig`** is the dispatch convention: point a section's template at it and it `include`s `_entries//`, falling back to `_entries/`, so each entry type gets its own template without per-section routing boilerplate. - **`_layouts/`** holds base layouts; templates `extend` `_layouts/base`. - **`_components/`** are self-contained, parameterized includes rendered with the `include … with { … } only` style so nothing leaks in from the parent scope. - **`_partials/`** is reserved for Craft element partials. - **`_includes/`** holds shared chrome such as the header, footer, and favicon. - **`_errors/`** holds error templates; `errorTemplatePrefix` (set in `config/craft/general.php`) points Craft's error pages at that folder. ### Quality tooling [](#quality-tooling) - **PHPStan** — `spark composer phpstan`, configured in `phpstan.neon` at level 5 and scoped to `src/modules`. - **Prettier** with `prettier-plugin-tailwindcss` for class sorting (config in `.prettierrc`). - **`.editorconfig`** — tabs, 4-wide (2-space for YAML and JSON). Configuration ------------- [](#configuration) Craft config lives in `config/craft/`: - `general.php`, `app.php`, `vite.php`, `seomate.php`, plus a shared `bootstrap.php` that defines the base/templates/config paths and loads the environment. - Redis is wired as the cache backend and Mailpit as the dev mailer in `app.php`, both driven by env vars. Environment files come as a per-environment trio: `.env.example.dev`, `.env.example.staging`, and `.env.example.production`. `spark create` copies the dev variant to `.env` (on the Composer path, the `post-create-project-cmd` script does the same); copy the staging/production variants onto their respective servers. Deployment ---------- [](#deployment) Two GitHub Actions workflows, built on the reusable composite actions in [`jalendport/spark-github-actions`](https://github.com/jalendport/spark-github-actions), handle deploys: - `.github/workflows/build-and-deploy--staging.yml` — deploys `develop`. - `.github/workflows/build-and-deploy--production.yml` — deploys `master`. Each builds (`composer install`, `npm install`, `npm run build`), rsyncs to the server, and triggers a Laravel Forge deployment. Set these repository secrets, per environment (prefix with `STAGING_` and `PRODUCTION_`): - `SSH_HOST` - `SSH_USER` - `SSH_KEY` - `SSH_PATH` - `FORGE_DEPLOY_TRIGGER_URL` > Note: the composite actions currently pin `php-8.3` and `node-22` variants, while the runtime images are on PHP 8.4. Support ------- [](#support) Found a bug or need help? Open an [issue](https://github.com/jalendport/spark-craft/issues). --- Made by [Jalen Davenport](https://jalendport.com) ### Health Score 26 — LowBetter than 40% of packages Maintenance52 Moderate activity, may be stable Popularity8 Limited adoption so far Community8 Small or concentrated contributor base Maturity31 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~240 days Total 4 Last Release 31d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/6537823?v=4)[Jalen Davenport](/maintainers/jalendport)[@jalendport](https://github.com/jalendport) --- Top Contributors [![jalendport](https://avatars.githubusercontent.com/u/6537823?v=4)](https://github.com/jalendport "jalendport (21 commits)") --- Tags craftcmscraftcms-boilerplatespark-boilerplatecmsprojectCraftcraftcms ### Code Quality Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/jalendport-spark-craft/health.svg) ``` [![Health](https://phpackages.com/badges/jalendport-spark-craft/health.svg)](https://phpackages.com/packages/jalendport-spark-craft) ``` ### Alternatives [craftcms/craft Craft CMS 205313.8k3](/packages/craftcms-craft) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)