/alejandra-chevey

Portfolio of Alejandra Chevey

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

Alejandra Chevey

Hugo website generated with Toolbox styleguide & Codeship CI/CD.

Staging CodeShip-CI Prod CodeShip-CI
Staging CodeShip-CI Prod CodeShip-CI

🔧 Prerequisites

First of all, you need to have the following tools installed globally on your environment:

  • hugo
  • npm
  • yarn

🚛 Install

  1. Setup your virtualhost (like http://alejandra-chevey.test) to serve /public.

    You must use the domaine alejandra-chevey.test, localy, if you want to use the Typekit kit of fonts.

  2. Install Hugo and dependencies using brew

    brew install hugo
  3. Install Toolbox and dependencies using yarn

    yarn install
  4. Build the website

    hugo server -D

After a git pull/merge

yarn build
hugo server

🚔 HTML5 validation

To assert the final output generated by Hugo is unbroken we use html5validator.

This module requires Python 2.7, 3.4, 3.5 or 3.6 and Java 8 (openjdk8 or oraclejdk8). Install with pip install html5validator.

Command Line Usage

html5validator --root public --format text

Enforce code standards with git hooks

Maintaining code quality by adding the custom post-commit hook to yours.

$ cat ./scripts/hooks/post-commit >> ./.git/hooks/post-commit

🎨 Build the theme

The main styleguide of Alejandra Chevey is inside this project under themes/alejandra-chevey/assets/. The styleguide is then processed using Toolbox.

You first need to setup the work environment by running yarn install.

You can generate the styleguide and watch it:

yarn start

You can generate only the built assets for production by running:

yarn build

For more help about Toolbox, the official documentation is your best friend.

🚀 Deploy

First time

# You need to have ruby & bundler installed
bundle install

Each times

We use Capistrano to deploy:

bundle exec cap -T
bundle exec cap staging deploy

🌐 Hosting & DNS

Solution hosted at Webfaction & DNS at Gandi.

SSL & Let's Encrypte

Managed throught Let's Encrypt Webfaction.