Skip to content

Démarrer

Deux façons de démarrer : générer un nouveau projet avec Castor Starter, ou ajouter un bundle à une application Symfony existante. Les deux prennent quelques minutes.

Option A — Générer un nouveau projet

Castor Starter est un task runner Castor qui automatise toute la mise en place : Symfony, infrastructure Docker, aropixel/admin-bundle, et tout bundle complémentaire dont vous avez besoin.

Prérequis : Castor, Docker + Docker Compose, PHP + Composer, et la CLI GitHub (gh) si vous comptez contribuer à un bundle.

bash
# 1. Cloner le projet
git clone git@github.com:aropixel/castor-starter.git
cd castor-starter

# 2. Installer les dépendances
composer install

# 3. Le rendre disponible partout sur votre machine
echo "alias castor-starter='\"$(pwd)/vendor/bin/castor\" --castor-file=\"$(pwd)/castor.php\"'" >> ~/.$(basename $SHELL)rc
source ~/.$(basename $SHELL)rc

Générez un projet admin complet, avec tous les bundles complémentaires :

bash
castor-starter aropixel:new:admin mon-projet --all

Cette seule commande vous donne une administration prête à l'emploi avec un compte admin par défaut, une stack Docker (PHP 8.2+, Nginx, MySQL, Varnish, Mailpit, phpMyAdmin) basée sur jolicode/docker-starter, la config de déploiement Clever Cloud, la gestion d'images via LiipImagineBundle, et un slug d'admin randomisé pour la sécurité.

→ Tous les détails sur la page Castor Starter.

Option B — Ajouter un bundle à un projet existant

Installez le bundle principal, créez votre premier utilisateur admin, et c'est parti :

bash
composer require aropixel/admin-bundle
php bin/console aropixel:admin:create-user

Puis ajoutez le ou les bundles complémentaires dont votre projet a besoin :

bash
composer require aropixel/page-bundle   # page builder visuel
composer require aropixel/blog-bundle   # articles & catégories
composer require aropixel/menu-bundle   # menus de navigation

Chaque bundle a son propre guide d'installation, avec extension d'entités, mapping Doctrine et routing — voir l'aperçu de l'écosystème pour les liens.

Prérequis

PHP8.2 ou supérieur
Symfony6.4 ou 7.x
LicenceMIT, sur chaque dépôt
LanguesFrançais, anglais, allemand, espagnol, italien, tchèque

→ Envie de voir à quoi ça ressemble avant d'installer quoi que ce soit ? Direction la page d'accueil.

Distribué sous licence MIT.