README

zebardast-dev/helix-starter

A production-ready starter theme built on HelixPress Framework.

Requirements

PHP 8.1+
WordPress 6.0+
Node.js & npm (for asset compilation)
Composer

Quick Start

1) Install via Composer

cd wp-content/themes
composer create-project zebardast-dev/helix-starter my-theme
cd my-theme

2) Setup environment

cp .env.example .env

3) Build assets

# Production build
npm install && npm run build

# Dev mode with live reload
npm run dev

npm run dev proxies your local site through browser-sync, guessing the URL from the theme's path. Set it explicitly if the guess is wrong:

DEV_URL=http://my-site.test npm run dev

Activate the theme from WordPress admin.

Local Development (with framework symlink)

To work on the framework and starter simultaneously, symlink the local framework:

composer config repositories.helix-framework \
  '{"type":"path","url":"../helix-framework","options":{"symlink":true}}'

git update-index --assume-unchanged composer.json

composer install

Server Hardening

The theme ships an .htaccess (Apache) and a web.config (IIS) that deny direct HTTP access to .env, Blade sources, PHP classes, logs and build scripts. Only style.css and the compiled assets under public/ stay reachable.

Nginx ignores both files — add this to the server block instead:

location ~* /wp-content/themes/[^/]+/(app|assets|bootstrap|config|core|resources|scripts|storage|vendor)/ {
    deny all;
}

location ~* /wp-content/themes/[^/]+/(\.|helix$|watch\.js|vite\.config\.js|postcss\.config\.mjs|.*\.(json|lock|md|ya?ml|example)$) {
    deny all;
}

Verify after deploying — this must return 403 or 404, never the file contents:

curl -I https://example.com/wp-content/themes/my-theme/.env

CLI

php helix list
php helix cache:clear
php helix make:component Alert
php helix make:composer Home
php helix db:seed

Documentation

Welcome to the HelixPress documentation.

The full documentation is currently being prepared. In the meantime, you can use the official docs portal below to explore the available guides and topics.

Official Documentation:
https://helix.runflare.run/

Topics coming soon

Getting Started
Configuration
Blade Templates
Components
View Composers
Models and Queries
Assets
Custom Post Types
CLI and Seeders
Inspector
WooCommerce
Actions and Filters
File Uploads

Credits

HelixPress was developed through a human-AI collaborative workflow.

Architecture & Product Direction: Mostafa Zebardast
Idea & Research: Mostafa Zebardast (@zebardast-dev), Amirhossein Zebardast (@amirz-dev)
Implementation & Coding: Mostafa Zebardast & Claude (Anthropic)
Review & Refinement: AI-assisted

This project reflects human-led design decisions, with AI utilized as a development partner for drafting, research, and implementation.

Changelog

See CHANGELOG.md.

License

MIT

zebardast-dev / helix-starter

Package info

Security

Statistics