README.md

Locomotive React Boilerplate

Boilerplate for React projects by Locomotive.

Installation

npm install

Usage

# watch
npm run start

# build
npm run build

# build svg
npm run build:svg

# build staging
npm run build:staging

# build production
npm run build:production

Components

To create a component, you can duplicate the Example component.

• It's defined as a functional component and imports its own scss file.
• It accepts 3 CSS class related props: option, utility and status.
• These props will be formated and added to the component className with the renderClasses utility.
• Options will be namespaced with -, utilities with u- and statuses with is-.
• You must defined your class props as arrays.
• Any changes to these class props will trigger a component render.

Dependencies

Name
Redux
React Router
React Transition Group

Learn More

• The boilerplate is based on Create React App.
• It uses styles from our Locomotive Boilerplate.