/skel

Primary LanguageMakefile

skel

Pré-requis

Les logiciels suivant doivent être installés sur la machine hôte :

Présentation

Principales fonctionnalités

  • Génération d'une application composé de conteneurs Docker pilotés par Docker Compose et GNU/Make
  • Initialisation des dépôts Git locaux et distants (optionnellement, sur Github)
  • Compatibilité avec Visual Studio Code Remote Containers
  • Mise à disposition dynamique des services publics à travers un proxy Traefik
  • Notification optionnelle de la création du dépôt dans un salon Rocket Chat
  • Mise à disposition d'outils de maintenance et de surveillance

Services

Application

  • apache : Image Docker basée sur l'image php:apache. Elle embarque les sources de l'application
  • db : Serveur des bases de données de l'application

Outils de maintenance et surveillance

  • adminer : Interface graphique de gestion des bases de données du service db
  • portainer : Interface graphique de gestion du serveur Docker
  • traefik : Routeur HTTP et TCP. Point d'entrée vers les différents services de l'applications

Utilisation

Création d'un nouveau projet à partir du squelette

cookiecutter https://github.com/kobischE/skel.git

Paramètres

  • docker_repository

    • Chemin vers un dépôt d'images Docker
    • par défaut : docker.io/{{ github_owner }}
  • git_remote_skel

    • URL du dépot Git hébergeant les sources du squelette
    • par défaut : git@github.com:{{ github_owner }}/skel.git
  • github_create_repo

    • Si true un dépôt distant est créé sur Github et les sources initiales du projet y sont ajoutées
    • par défaut : false
  • github_owner

    • Identifiant d'un utilisateur ou d'une organisation Github
  • project_name

    • Le nom complet du projet
    • par défaut : Un projet sacrément prometteur
  • project_slug

    • L'identifiant textuel du projet
    • par défaut : {{ project_name.lower().replace(' ', '-').replace('\\'', '-') }}
  • rocketchat_hook_url

Développement

Exécution de la suite de tests

make test