diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..4a15113 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contribution au site JDIS + +## Démarrage rapide + +1. Forker le projet +![fork a repo](https://docs.github.com/assets/cb-79331/images/help/repository/fork_button.png) + +2. Cloner le dépôt forké +```bash +git clone https://github.com/${your_username}/Website.git +``` + +3. Configurer le dépôt distant (upstream) +```bash +git remote add upstream https://github.com/JDIS/Website.git +``` + +4. Assurez-vous de récupérer les dernières modifications de l'upstream +```bash +git pull upstream main +git push origin master # to update your remote fork +``` + +5. Crée une branche séparée +```bash +git checkout -b feat/${name_of_your_modification} +``` + +6. Effectuer les modifications + +7. Ajouter les nouveaux fichiers modifiers + +8. Effectuer un commit de vos modifications + +7. Pousser vos modifications +```bash +git push origin feat/${name_of_your_modification} +``` + +10. Créer une pull request sur Github \ No newline at end of file diff --git a/Gemfile b/Gemfile index 9d2f64d..53144b3 100644 --- a/Gemfile +++ b/Gemfile @@ -8,7 +8,7 @@ source "https://rubygems.org" # # This will help ensure the proper Jekyll version is running. # Happy Jekylling! -gem "jekyll", "~> 3.8.4" +# gem "jekyll", "~> 3.8.4" # This is the default theme for new Jekyll sites. You may change this to anything you like. gem "minima", "~> 2.0" diff --git a/Gemfile.lock b/Gemfile.lock index 3fc603b..dbd856b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -68,7 +68,6 @@ GEM concurrent-ruby (~> 1.0) tzinfo-data (1.2019.3) tzinfo (>= 1.0.0) - wdm (0.1.1) PLATFORMS ruby @@ -76,11 +75,9 @@ PLATFORMS x86-mingw32 DEPENDENCIES - jekyll (~> 3.8.4) jekyll-feed (~> 0.6) minima (~> 2.0) tzinfo-data - wdm (~> 0.1.0) BUNDLED WITH - 1.17.2 + 1.17.3 diff --git a/README.md b/README.md index efeb214..9cddc08 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,13 @@ Ce dépôt contient les ressources du site web public de JDIS, accessible à l'a ## Pour démarrer le projet -### 1. Installer les dépendances globales - -Vous devez installer [Ruby](https://www.ruby-lang.org/fr/documentation/installation/). - -Une fois que Ruby est installé, vous devez installer Bundler : - -```sh -gem install bundler -``` - -### 2. Cloner le dépôt - ```sh -git clone git@github.com:JDIS/Website.git && cd Website +docker-compose up ``` -### 3. Installer les dépendances du projet - -```sh -bundle install -``` - -### 4. Démarrer le serveur - -```sh -bundle exec jekyll serve -``` +Le site web devrait être disponible localement à l'adresse suivante: . -Le site web devrait être disponible localement à l'adresse suivante: . ## Pour contribuer -Vos contributions sont les bienvenues. Que ce soit pour ajouter un événement, une photo ou une information, vous pouvez créer une _pull request_ depuis la branche qui contient vos modifications. +Vos contributions sont les bienvenues. Merci de [suivre le guide de contribution](./.github/CONTRIBUTING.md) diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..058f9bb --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +version: '3.9' + +services: + web: + image: 'jekyll/jekyll:3.8' + volumes: + - '.:/app' + working_dir: '/app' + ports: + - '10529:4000' + - '35729:35729' + command: 'jekyll serve --livereload' \ No newline at end of file