nils-framework/nils-app

Squelette officiel d'application pour le framework HTTP NILS

v1 2026-05-31 18:24 UTC

Requires

• php: >=8.2
• nils-framework/nils-core: ^1.0

MIT

• Traore

• framework
• api
• nils
• burkina-faso

README

Bienvenue dans votre nouvelle application propulsée par le framework NILS !
Ce squelette fournit une architecture propre et sécurisée pour concevoir des APIs REST performantes.

🛠️ Configuration Initiale

1. Cloner/Générer le projet

Pour démarrer un nouveau projet, utilisez la commande Composer officielle :

composer create-project nils-framework/nils-app mon-api

2. Configurer l'environnement

Copiez le fichier de configuration d'exemple et adaptez ses valeurs à vos besoins :

cp .env.example .env

Ouvrez le fichier .env pour configurer votre fuseau horaire, vos accès de base de données et la gestion des origines CORS.

3. Lancer le serveur local de test

Pour tester rapidement votre API sans configurer Apache ou Nginx, utilisez le serveur interne de PHP depuis la racine du projet :

php -S 127.0.0.1:8000 -t public/

Visitez ensuite http://127.0.0.1:8000 ou testez votre route de démonstration.

📂 Structure du projet

• public/ : Seul dossier exposé sur le Web. Contient le point d'entrée index.php et les règles d'URL .htaccess.
• src/ : Votre code métier (Contrôleurs, Modèles, Services). Enregistré sous le namespace App\.
• journaux/ : (Créé automatiquement) Contient les fichiers de logs de plantages de l'API (erreurs.log).

🔥 Mise en ligne sur Packagist

Une fois vos 3 dépôts créés avec les fichiers complets :

1. Publiez nils-contracts sur Packagist.
2. Publiez nils-core sur Packagist.
3. Publiez nils-app (ce dépôt) sur Packagist.

À partir de cet instant, n'importe quel développeur tape :

composer create-project nils-framework/nils-app mon-projet

Et se retrouve avec cette structure prête à coder en moins de 10 secondes !