Setup for your local environment for development

Requirements

This repo uses Jekyll to serve and build the markup of the site. CSS and JS are managed by Gulp.

Thus you will need Ruby ( > version 2.4.2 ) and Node ( > 11.6 ). The Node install will also provide npm, the Node package manager.

You may consider using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.

On OS X, you can also use Homebrew to install Ruby in /usr/local/bin, which may require you to update your $PATH environment variable. Here are the commands to follow to install via homebrew:

$ brew update
$ brew install ruby
$ brew install node

If you do use rbenv it is important to set your global Ruby version to 2.4.2 or higher so that you can install gems properly:

$ rbenv global

Installation

Now that you have verified that you have Ruby and Node installed, run the following commands to install the packages that the design system depends upon:

$ bundle install
$ npm install -g gulp
$ npm install -g gulp-cli
$ npm install
$ npm run build

The post-install step should run bundle install.

Development

To view and work on the site run:

$ npm start

This will perform the necessary Jekyll build, generate concatenated CSS and JS files, serve the site, and watch for changes to Sass and JS files. You should now be able to visit http://localhost:4000/ and view the site locally.

Questions or need help with setup? Feel free to open an issue here https://github.com/labopm/website/issues.