README

Velt Skeleton est le point de depart officiel pour creer une application Velt. Il fournit une base production-ready pour une demo complete: frontend declaratif, routes HTTP, API JSON, configuration, base de donnees, migrations, seeders, ORM, Tailwind et tests.

Velt reste volontairement simple: une application PHP moderne, organisee en MVC + feature-based, avec une syntaxe UI declarative en .velt.php.

Installation

composer install
cp .env.example .env
php bin/velt migrate
php bin/velt db:seed
php bin/velt serve
php bin/velt preview

Sur Windows PowerShell:

composer install
Copy-Item .env.example .env
php bin/velt migrate
php bin/velt db:seed
php bin/velt serve
php bin/velt preview

L'application ecoute par defaut sur toutes les interfaces (0.0.0.0:8000). php bin/velt preview detecte l'adresse reseau du PC et la place dans le QR:

php bin/velt serve
php bin/velt preview

Le terminal affiche l'URL locale et l'URL mobile. Le telephone doit etre sur le meme Wi-Fi. Si la detection automatique ne convient pas, l'adresse peut etre fournie explicitement:

php bin/velt serve 0.0.0.0:8000
php bin/velt preview 192.168.1.20:8000

Stack incluse

velt/framework pour l'assemblage applicatif.
velt/http pour les routes, requetes, reponses et dispatch.
velt/ui pour les pages declaratives .velt.php.
velt/database pour PDO, query builder, schema builder, migrations et seeders.
velt/orm pour les modeles Active Record.
Tailwind CSS configure par defaut.
PHPUnit pour les tests de fumee et d'integration.

Architecture

Le skeleton suit une architecture MVC + feature-based.

features/
  Home/
    Controllers/
      HomeController.php
  Documentation/
    Controllers/
      DocumentationController.php
  Projects/
    Controllers/
      ProjectApiController.php
    Models/
      Project.php
  Shared/
    Controllers/
      Controller.php

resources/
  views/
    homepage.velt.php
    docs.velt.php
    database.velt.php
  css/
    app.css

database/
  migrations/
    2026_07_13_000000_create_projects_table.php
  seeders/
    DatabaseSeeder.php

routes/
  web.php
  api.php

Chaque feature regroupe sa logique applicative. Les controllers restent dans features/*/Controllers, les models dans features/*/Models, et les vues declaratives dans resources/views.

Routes

Methode	URI	Action
GET	`/`	Page welcome Velt
GET	`/docs`	Documentation rapide du projet
GET	`/database`	Explication backend et database
GET	`/api/projects`	JSON depuis `App\Projects\Models\Project`
GET	`/api/preview/{id}`	JSON Velt de la vue associee a une session preview
GET	`/api/preview-route/{path}`	JSON Velt pour une route web connue (`docs`, `database`, `homepage`)
GET	`/api/session/{id}`	Informations de session preview
GET	`/api/preview/demo`	Erreur JSON propre pour la preview sans session

Vues Velt

Les pages ne sont pas ecrites en HTML brut. Une vue Velt retourne une instance Velt\Ui\Page.

<?php

use Velt\Ui\Components\Card;
use Velt\Ui\Components\Text;
use Velt\Ui\Page;

return Page::make('Dashboard')
    ->meta(['title' => 'Dashboard - Velt'])
    ->add(
        Card::make()
            ->class('panel')
            ->add(Text::make('Bienvenue')->as('h1'))
    );

Le rendu web est assure par Velt\Ui\Renderers\WebRenderer.

Base de donnees

SQLite est configure par defaut pour faciliter les demos locales.

DB_CONNECTION=sqlite
DB_DATABASE=database/database.sqlite

Lancer les migrations:

php bin/velt migrate

Charger les donnees de demo:

php bin/velt db:seed

Rollback de la derniere batch:

php bin/velt migrate:rollback

Exemple de modele:

namespace App\Projects\Models;

use Velt\Orm\Model;

final class Project extends Model
{
    protected static string $table = 'projects';
}

Tailwind

Tailwind est inclus par defaut pour que chaque nouveau projet Velt ait une base frontend propre.

npm install
npm run build

Fichiers principaux:

tailwind.config.js
postcss.config.js
resources/css/app.css
public/assets/app.css

La page welcome utilise une identite blanche et bleu royal vers bleu ciel, avec le logo Velt dans public/assets/velt-logo.png.

CLI

php bin/velt help
php bin/velt serve
php bin/velt kernel:check
php bin/velt preview [host:port] [view]
php bin/velt preview docs
php bin/velt migrate
php bin/velt migrate:rollback
php bin/velt db:seed

Tests

composer test

Les tests couvrent:

rendu de la page welcome;
pages /docs et /database;
migration projects;
seeder DatabaseSeeder;
modele ORM Project;
API /api/projects;
contrat JSON de /api/preview/demo;
creation de session preview, QR SVG et JSON de la vraie vue Velt;
navigation JSON preview pour les routes documentees.

Checklist production

Avant publication:

composer validate
composer install
composer test
php bin/velt kernel:check
php bin/velt migrate
php bin/velt db:seed

Pour une release Packagist, taguer le repo seulement quand cette checklist est verte.

velt / skeleton

Maintainers

Package info

Statistics

Security