Sud Web 2019

Site internet du cycle de conférences annuel Sud Web, dont la 9e édition aura lieu en mai 2019.

Pré-requis

Le site est généré à l'aide de Jekyll et nécessite Ruby 2.6.1 (voir .ruby-version)

Installation avec Docker

export JEKYLL_VERSION=3.8

docker run --rm --volume="$PWD:/srv/jekyll" -p 3000:4000 -it jekyll/jekyll:$JEKYLL_VERSION jekyll serve

La version dev est consultable ensuite à l'adresse localhost:3000/2019

Installation en local

Nous vous recommandons de gérer l'installation de Ruby via rbenv.

Sous Mac OS X, vous pouvez utiliser Homebrew pour cela

$ brew install rbenv ruby-build

Sous GNU/Linux, certaines librairies sont nécessaires (à adapter à votre gestionnaire de paquets) :

sudo apt-get install -y libreadline-dev build-essential

Puis pour rbenv et ruby-build, préférer une installation par git :

$ git clone https://github.com/rbenv/rbenv.git ~/.rbenv
$ cd ~/.rbenv && src/configure && make -C src
$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
$ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build

Installation

Si vous n'avez pas déjà cloné le dépot :

$ git clone https://github.com/sudweb/2019.git && cd 2019

Si bundler n'est pas installé

$ gem install bundler

Pour installer toutes les dépendances du projet :

$ bundle install;
$ bundle exec rake prebuild:install;

Si vous avez des problèmes pour l'installation de nokogiri :

$ gem update --system;
$ bundle config build.nokogiri --use-system-libraries

Pour installer la bonne version de Ruby avec rbenv :

$ rbenv install

Travailler en local

Pour travailler sur le site et surveiller les modifications :

$ bundle exec rake build:serve

Pour builder pour le Dév

$ bundle exec rake build:dev

Pour builder pour la Production

$ bundle exec rake build:prod

Si vous modifiez le fichier _config.yml, il faut couper et relancer.

Le site est maintenant accessible en local à l'adresse http://127.0.0.1:4000/ (dev).

Pour plus d'information sur l'utilisation de Jekyll, reportez-vous à la documentation officielle.

Contribution

Pour toute demande, merci de créer une issue sur GitHub.

Si vous souhaitez nous aider, vous pouvez copier le dépôt, faire vos modifications dans une nouvelle branche et faire une demande de fusion.

Toute modification doit faire l'objet d'une pull request et doit passer les tests avant de pouvoir être fusionnée.

Tests

Avant de soumettre votre pull-request, vérifiez que les tests passent :

$ bundle exec rake postbuild:test:kiss

Licence

Ce code est publié sous licence MIT.

simon-previdente / 2019