Guide de contribution - Relaticle  

 [Guides développeur](https://relaticle.com/fr/developers)

 Guide de contribution 
=======================

Installez l'environnement de développement de Relaticle et découvrez son code PHP 8.5, Laravel 13 et Filament 5 avant d'ouvrir votre première PR.

 Mis à jour le 29 octobre 2026

Documentation technique pour les développeurs et les contributeurs.

---

[](#démarrage-rapide "Permalink")Démarrage rapide
-------------------------------------------------

```
git clone https://github.com/Relaticle/relaticle.git
cd relaticle && composer app-install
composer run dev

```

Ouvrez `http://localhost:8000` pour accéder à l'application.

---

[](#stack-technique "Permalink")Stack technique
-----------------------------------------------

| Composant | Technologie |
|---|---|
| Backend | PHP 8.5, Laravel 13 |
| Interface d'administration | Filament 5 |
| Frontend | Livewire 4, Alpine.js, Tailwind CSS 4 |
| Base de données | PostgreSQL |
| File d'attente | Laravel Horizon |
| Tests | Pest v5 |
| Analyse statique | PHPStan (niveau 7) |
| Style de code | Laravel Pint, Rector |
| Authentification | Laravel Jetstream |

---

[](#architecture "Permalink")Architecture
-----------------------------------------

### [](#modèles-principaux "Permalink")Modèles principaux

```
Workspace ─┬─ User (via Membership)
           ├─ Company ─┬─ People
           │           └─ Opportunity ─── People
           ├─ Task (many-to-many with Company, People, Opportunity)
           └─ Note (many-to-many with Company, People, Opportunity)

```

### [](#architecture-multi-tenant "Permalink")Architecture multi-tenant

Les données de chaque espace de travail sont isolées grâce au trait `HasWorkspace`. Chaque requête est automatiquement limitée à l'espace de travail courant.

### [](#traits-principaux "Permalink")Traits principaux

| Trait | Rôle |
|---|---|
| `HasWorkspace` | Isolation par espace de travail |
| `HasCreator` | Enregistre l'auteur de la création d'un enregistrement |
| `HasNotes` | Relation polymorphe avec les notes |

---

[](#installation-pour-le-développement "Permalink")Installation pour le développement
-------------------------------------------------------------------------------------

### [](#prérequis "Permalink")Prérequis

- **PHP 8.5+** avec les extensions : pdo\_pgsql, gd, bcmath, mbstring, xml
- **PostgreSQL 17+**
- **Node.js 22+** avec pnpm
- **Composer 2+**

### [](#installation-manuelle "Permalink")Installation manuelle

```
git clone https://github.com/Relaticle/relaticle.git
cd relaticle
composer install
pnpm install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan storage:link
pnpm run build
composer run dev

```

### [](#configuration-de-lenvironnement "Permalink")Configuration de l'environnement

Pour PostgreSQL :

```
DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=relaticle
DB_USERNAME=postgres
DB_PASSWORD=your_password

```

---

[](#outils-de-qualité "Permalink")Outils de qualité
---------------------------------------------------

```
composer lint          # Format with Pint + Rector
composer test:lint     # Check formatting
composer test:types    # PHPStan analysis
composer test:pest     # Run tests
composer test          # All checks (required before PR)

```

### [](#hooks-git "Permalink")Hooks Git

Activez les vérifications avant commit :

```
git config core.hooksPath .githooks

```

---

[](#tests "Permalink")Tests
---------------------------

Toute contribution exige :

- Des tests de fonctionnalité passant par les vrais points d'entrée pour tout nouveau comportement
- Des tests de fonctionnalité pour les interactions utilisateur
- 100 % de couverture des types

Lancez des tests précis :

```
php artisan test tests/Feature/ExampleTest.php
php artisan test --filter="test_method_name"

```

---

[](#attributs-personnalisés "Permalink")Attributs personnalisés
---------------------------------------------------------------

Relaticle inclut un système d'attributs personnalisés qui permet d'étendre les entités sans migration.

- **Licence** : AGPL-3.0 (gratuite pour l'open source) ou commerciale
- **Documentation** : [Documentation des attributs personnalisés](https://relaticle.github.io/custom-fields/)

---

[](#déploiement "Permalink")Déploiement
---------------------------------------

Pour le déploiement en production, y compris la configuration Docker, l'environnement, le reverse proxy et les guides propres à chaque plateforme (Dokploy, Coolify), consultez le **guide d'auto-hébergement**.

---

[](#dépannage "Permalink")Dépannage
-----------------------------------

| Problème | Solution |
|---|---|
| La file d'attente ne traite rien | `php artisan queue:restart` |
| Erreurs d'envoi de fichiers | `chmod -R 775 storage bootstrap/cache` |
| Problèmes de cache des vues | `php artisan view:clear && pnpm run build` |

---

[](#contribuer "Permalink")Contribuer
-------------------------------------

1. Faites un fork du dépôt
2. Créez une branche de fonctionnalité : `git checkout -b feat/your-feature`
3. Apportez vos modifications en respectant les normes de code
4. Lancez les tests : `composer test`
5. Faites un commit avec des messages conventionnels
6. Ouvrez une Pull Request
7. Lors de votre première PR, signez le [Contributor License Agreement](https://github.com/relaticle/relaticle/blob/main/.github/CLA.md) en répondant par la phrase que publie le bot CLA

Les PR doivent réussir toutes les vérifications et avoir un CLA signé avant la fusion.

---

[](#ressources "Permalink")Ressources
-------------------------------------

- [Documentation Laravel](https://laravel.com/docs/13.x)
- [Documentation Filament](https://filamentphp.com/docs)
- [Documentation Livewire](https://livewire.laravel.com/)
- [Documentation Pest](https://pestphp.com/)

 [  Modifier cette page sur GitHub ](https://github.com/Relaticle/relaticle/edit/main/packages/Documentation/resources/content/docs/guides/contributing.md) [  Poser une question sur Discord ](https://relaticle.com/discord) [    Contacter le support ](https://relaticle.com/fr/contact)
