Skip to content

Un template robuste pour organiser et déployer des services en production de manière cohérente et maintenable.

License

Notifications You must be signed in to change notification settings

CtrlMajSup/skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Service skeleton

Un template robuste pour organiser et déployer des services en production de manière cohérente et maintenable.

🎯 Objectif

Ce template fournit une structure standardisée pour déployer et gérer des services, en couvrant tous les aspects essentiels :

  • Organisation du code et des instances
  • Gestion des sauvegardes
  • Configuration et personnalisation
  • Scripts de maintenance et de déploiement
  • Documentation complète

📁 Structure

.
├── instances/        # Code et configuration spécifique du service
├── backups/         # Sauvegardes (quotidiennes, hebdomadaires, mensuelles)
├── docs/            # Documentation complète du service
├── scripts/         # Scripts de gestion et maintenance
├── traits/          # Configurations de base (remplace les configs existantes)
└── events/          # Logs des scripts et événements

🚀 Installation

  1. Clonez ce repository :
git clone https://github.com/votre-username/service-scaffold.git
  1. Renommez le dossier selon votre service :
mv service-scaffold mon-service
cd mon-service
  1. Supprimez le dossier .git pour démarrer un nouveau projet :
rm -rf .git
git init

💡 Bonnes Pratiques

  • Privilégiez les tirets (-) plutôt que les underscores (_) dans les noms de fichiers
  • Configurez votre alias ls pour plus de lisibilité : alias ls='ls -l --color=auto'
  • Suivez la documentation dans chaque sous-dossier pour une configuration optimale

📘 Documentation

Chaque sous-dossier contient son propre README avec des instructions détaillées sur :

  • L'utilisation spécifique du dossier
  • Les conventions à suivre
  • Les configurations recommandées
  • Les cas d'usage courants

🤝 Contribution

Les contributions sont les bienvenues ! N'hésitez pas à :

  • Ouvrir une issue pour signaler un bug ou suggérer une amélioration
  • Proposer une pull request pour ajouter une fonctionnalité
  • Partager vos retours d'expérience

📝 License

MIT License


Développé avec ❤️ pour simplifier le déploiement et la maintenance des services

About

Un template robuste pour organiser et déployer des services en production de manière cohérente et maintenable.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages