Setup

You'll need some dependencies installed before you can work with Slate. Chances are you have these installed already.

Core

If you only using Slates core as part of your own build engine, you can use this package to install it into your node_modules folder.

$ yarn add slatecore -D

However this will leave you stuck with the default settings which you are most likely going to want to change. The easiest way to proceed from there is to add the config repo files to your project, and add build on from there.

With those files in your project, you simply import the configs and Slate with one line:

@import 'slate-engine.scss';

To learn more Slates configuration files, read the documentation.

Engine

If you need a build engine to process things like SASS, Javascript and Images, you can use Slates engine, which is built on NPM scripts and Laraval Mix.

$ git clone https://github.com/HashandSalt/slateengine.git && yarn install -D

Prerequisites

In order to use Slate Engine, some dependencies are required. These are laid out below. You can learn more about the engine here.

Node

The easiest way to install and manage Node is with NVM. This tool allows you to install multiple versions of Node and switch between them on demand. Head on over to the NVM setup guide and follow the instructions. With NVM installed, you can use it to get the latest version of Node:

$ nvm install node

Yarn

Whilst you can use NPM if you wish, Yarn is much more efficient and installs dependencies much faster. You can learn how to install it here.

Built with the Best

Slate was built by Hash&Salt, a company who loves building for the internet. Using the very best in industry leading software and practices honed over the last 20 years in the industry. You're in good hands.