Front End Styleguide

Pattern library framework for styleguide driven development with Sass, ES6+ and Nunjucks.

Installation

# Yarn
yarn global add front-end-styleguide-cli

# npm
npm install -g front-end-styleguide-cli

Project Creation

mkdir new-project
cd new-project
front-end-styleguide init

Usage

# Start dev server
yarn dev
# or
npm run dev

# Build files for production
yarn build
# or
npm run build

# Build static styleguide with prototypes and components
yarn build:dev
# or
npm run build:dev

# Build static styleguide with prototypes only
yarn build:proto
# or
npm run build:proto

# Run linting
yarn lint
# or
npm run lint

# Run unit and e2e tests
yarn test
# or
npm run test

For more information take a look at the docs.

Test the core package

# Linting
yarn lint
# or
npm run lint

# Automated testing
yarn test
# or
npm run test

# Dev server and build testing
yarn test:dev
yarn test:build
yarn test:build:dev
yarn test:build:proto
# or
npm run test:dev
npm run test:build
npm run test:build:dev
npm run test:build:proto