https://github.com/mus-inn/devcontainer-dotworld
https://github.com/mus-inn/devcontainer-dotworld
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mus-inn/devcontainer-dotworld
- Owner: mus-inn
- Created: 2024-07-26T23:49:15.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-12-03T17:16:39.000Z (5 months ago)
- Last Synced: 2025-01-21T10:09:55.879Z (3 months ago)
- Language: Shell
- Size: 8.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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` :
```bash
wget https://github.com/mus-inn/devcontainer-dotworld/releases/latest/download/dotinstall.sh
```
- Ou avec `curl` :
```bash
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
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 ! đ„
[
](https://www.loom.com/embed/fff183d5ca584c81bfe606492c3554bb?sid=7077acb9-0b24-401f-bfd9-b4d4d173413c)
## 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
[
](https://www.loom.com/embed/3774cc5679db427bb63967fe31a5be82?sid=08cc0d25-300d-4d34-acda-a4263c5f3ab9)
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
[
](https://www.loom.com/embed/ecc50557a21e4d80b8a5e5754743ebe2?sid=b0edbc9e-0eaa-43b2-9c65-daa7ea22746d)
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
[
](https://www.loom.com/embed/1d83a49fd6fa4000bbda2806f9dce7a7?sid=32410d33-9cae-4c72-819d-8b3efa4f7e12)
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 :
[
](https://www.loom.com/embed/557393061bf14e7b90b5e74653f894fb?sid=d7e56d1e-8491-4af7-8794-8acb4d762aee)
### Créer ou Modifier une Stack Existante
[
](https://www.loom.com/embed/f17c549d79a0477dbfaa1e6f6dddae4b?sid=2a4e17d7-dd06-48db-908c-1da9000e22c5)
[
](https://www.loom.com/embed/73777a437bb041aea2d4d2e85bbe1058?sid=163e7356-17e6-421b-8c19-1db927d7bf53)
#### 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 :
```bash
dotdev share
```
ou bien :
```bash
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` :
```bash
dotdev share http://localhost:8000 --force
```
## Jâaimerais Apporter ma Contribution ou J'ai RepĂ©rĂ© un Bug đ
[
](https://www.loom.com/embed/4ec0cb3ecbb04dca9f5acd1c1227f38d?sid=a8116445-2c91-4402-a35c-4099fcf36e96)
## Support et Contribution đ
Pour toute question ou problÚme, veuillez ouvrir une issue sur notre [dépÎt GitHub](https://github.com/mus-inn/devcontainer-dotworld/issues). Les contributions sont les bienvenues. N'hésitez pas à proposer des améliorations ou à signaler des bugs.
Merci d'utiliser Dotinstall ! đ