Skip to content

mus-inn/devcontainer-dotworld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

130 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DotInstall 🚀

Bienvenue chez Dotworld, dĂ©veloppeur superstar! 🌟 Voici DotInstall, l'outil incontournable pour gĂ©rer et installer vos environnements de dĂ©veloppement en toute simplicitĂ©.

En quoi consiste DotInstall ? đŸ€”

DotInstall vous permet de :

  • Compiler de nouvelles images Docker 🐳
  • Construire des stacks de devcontainer prĂȘtes Ă  l'emploi đŸ› ïž
  • Mettre Ă  jour Dotdev, le cƓur de votre environnement de dĂ©veloppement, qui configure tout dĂšs le dĂ©marrage et vous offre une commande magique pour interagir avec vos environnements ✹

Comment utiliser Dotinstall.sh đŸ› ïž

PrĂ©requis ✅

Avant de commencer, assurez-vous d'avoir installé wget ou curl sur votre machine. Placez-vous ensuite dans le codespace de votre projet ou dans votre dépÎt git local.

Installation đŸ’»

  1. Téléchargez la derniÚre version de dotinstall.sh :

    • Avec wget :

      wget https://github.com/mus-inn/devcontainer-dotworld/releases/latest/download/dotinstall.sh
    • Ou avec curl :

      curl -L -o dotinstall.sh https://github.com/mus-inn/devcontainer-dotworld/releases/latest/download/dotinstall.sh
  2. Exécutez le script téléchargé :

    bash dotinstall.sh
  3. Suivez les instructions Ă  l'Ă©cran. Le formulaire est interactif et vous guidera tout au long du processus 📝.

Découvrez Dotinstall en action :

Bienvenue dans notre sĂ©rie de vidĂ©os expliquant le projet devcontainer Dotworld ! đŸŽ„

Structure du Projet

Le projet est organisé en trois dossiers principaux :

  1. docker-build : Contient les images Docker à créer pour nos conteneurs de développement.
  2. .dev : Centralise les commandes et automatisations des conteneurs de développement, avec des commandes par défaut et des utilitaires.
  3. stacks : Représente les différentes stacks installables, telles que "starter" et "PHP 8.1, Next.js".

Outils Disponibles

  1. dotInstall : Démarrez un environnement de développement, compilez des images, et mettez à jour les outils nécessaires.
  2. build docker dotworld : Compilez des images Docker personnalisées à partir du dépÎt devcontainer dotworld, en adaptant les paquets et technologies.

Utilisation des Outils

  • Utilisez dotInstall pour crĂ©er un nouvel espace de dĂ©veloppement en sĂ©lectionnant une stack et en dĂ©marrant l'environnement.
  • Avec build docker dotworld, compilez des images adaptĂ©es Ă  vos besoins spĂ©cifiques, comme passer de PHP 8.1 Ă  PHP 8.2.

Compilation et Publication

  • Le build docker dotworld peut ĂȘtre effectuĂ© localement pour des tests ou pour une publication sur Docker Hub, prenant en charge les architectures x86 et ARM64.

Création ou Mise à Jour d'un Devcontainer avec Codespace

Pour installer un devcontainer sur un dépÎt avec CodeSpace, suivez ces étapes :

  1. Allez dans le dépÎt souhaité, cliquez sur "Code", puis sélectionnez "CodeSpace".
  2. Une fois que le conteneur de base a démarré, ouvrez le README du devcontainer pour obtenir les commandes nécessaires.
  3. Utilisez curl ou wget pour télécharger les fichiers requis dans le terminal du CodeSpace.
  4. Téléchargez la derniÚre version de dotinstall et exécutez-la pour installer l'environnement de développement.
  5. Configurez le devcontainer selon la technologie, par exemple avec la stack Next.js.
  6. Redémarrez le CodeSpace avec l'icÎne de rechargement ou la commande Ctrl+P, puis rebuild.
  7. Vous ĂȘtes prĂȘt Ă  travailler dans votre nouvel environnement de dĂ©veloppement !

Suivez les instructions pour ouvrir les ports nĂ©cessaires et saisissez le mot de passe demandĂ© pour dĂ©marrer votre session. Profitez de votre nouvel environnement de dĂ©veloppement avec CodeSpace ! 🌐

Création ou Mise à Jour d'un Devcontainer Local

Pour installer le DevContainer localement, procédez comme suit :

Installer DevContainer CLI

Pour gérer des DevContainers via la ligne de commande de maniÚre globale :

Assurez-vous que npm (Node.js) ou Python (pour pip) est installé. Avec npm : Installez le package @devcontainers/cli :

npm install -g @devcontainers/cli

Avec pip (si disponible) : Installez le CLI pour gérer les DevContainers :

pip install devcontainer

Configurer un DevContainer

Dans un projet :

Créez un dossier .devcontainer à la racine. Ajoutez un fichier devcontainer.json ou Dockerfile pour décrire votre configuration. Démarrez le DevContainer : Si vous utilisez VS Code, ouvrez le projet, et exécutez Dev Containers: Reopen in Container dans la palette de commandes (Cmd+Shift+P). Sinon, utilisez la CLI :

devcontainer up
  1. Assurez-vous d'avoir Docker installé sur votre machine.
  2. Clonez le projet dans le répertoire souhaité avec git clone.
  3. Accédez au répertoire du projet et téléchargez Dotinstall avec curl ou wget.
  4. Exécutez bash dotinstall pour télécharger et installer le DevContainer.
  5. Une fois l'installation terminée, vous verrez le .devcontainer dans le répertoire.
  6. Sortez du répertoire avec cd ...
  7. Lancez le DevContainer avec devcontainer up --workspace-folder Test-World-Frontend.
  8. Utilisez Visual Studio Code pour accéder au projet dans le DevContainer.

Présentation de Dotdev

Dotdev fournit un terminal avec un en-tĂȘte mis Ă  jour Ă  chaque rĂ©initialisation. Personnalisez le message de bienvenue en modifiant le fichier "welcome" dans le rĂ©pertoire "custom".

  • Le fichier "install" exĂ©cute des commandes au dĂ©marrage, idĂ©al pour prĂ©parer l'environnement (par ex. installation de dĂ©pendances).
  • Les "alias" permettent de crĂ©er des raccourcis dans le terminal.
  • Les "commandes" permettent de dĂ©finir des actions personnalisĂ©es pour votre projet.

Dotdev vous permet de mettre à jour le conteneur de développement, de changer l'environnement, et de gérer les images Docker. Utilisez dotdev pour simplifier vos tùches courantes sans mémoriser une tonne de commandes.

â„č tip: dotdev se lance depuis le container Docker, il faut donc d'abord executer make bash depuis la racine du projet pour aller dans le container.

Créez de Nouvelles Commandes pour Vous et vos CollÚgues :

Créer ou Modifier une Stack Existante

Utiliser le depot local pour le developpement de votre Stack

💡 If you want to use local devcontainer-dotworld repository, please add the following code to your .bashrc/.zshrc to set the vars

    export DEVCONTAINER_USE_LOCAL_REPOSITORY=true 
    export DEVCONTAINER_LOCAL_REPOSITORY_FULLPATH=/path/to/devcontainer-dotworld # Change this to your local repository path

This mode will use the local repository instead of the remote one.

Comment start mon devcontainer

Se mettre dans le repertoire et lancer cette commande

devcontainer up --workspace-folder .

Comment exposer le port de votre application en public sur Codespaces

Exposer son application

Pour exposer votre application, rien de plus simple :

dotdev share

ou bien :

dotdev share http://localhost:8000

Par défaut, le partage se fera sur l'hÎte 127.0.0.1:80.
Si le sous-domaine existe déjà, considérez-vous chanceux avec une probabilité de 1 sur plus de 10 000.
Dans ce cas, vous pouvez forcer la création d'un nouveau sous-domaine en ajoutant l'option --force :

dotdev share http://localhost:8000 --force

J’aimerais Apporter ma Contribution ou J'ai RepĂ©rĂ© un Bug 🔍

Support et Contribution 🙌

Pour toute question ou problÚme, veuillez ouvrir une issue sur notre dépÎt GitHub. Les contributions sont les bienvenues. N'hésitez pas à proposer des améliorations ou à signaler des bugs.

Merci d'utiliser Dotinstall ! 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 6