@schoonlabs/blocks v1.0.2

SchoonLabs Blocks

Overview

The following project is a shared component library to be used when developing SchoonLabs projects.

Development

Below is an example of how to get started with developing shared components.

Create a new shared Component

• Create a new Component directory containing some of the common files that you'll need:

cd components/packages
mkdir [COMPONENT_NAME]

• Create some of the common files that you'll need:

cd [COMPONENT_NAME]
touch [COMPONENT_NAME].js [COMPONENT_NAME].md [COMPONENT_NAME].scss

• Now in your code editor you can begin editing the contents of your files

Code Quality

This project uses ESLint and Prettier to help maintain code quality.

Setting up Prettier

• Install the Prettier plugin for your IDE (ie. IntelliJ)
• Setup Prettier to auto-correct errors on save:
  • In IntelliJ you can try to configure and use File Watchers (warning: buggy)
  • Alternatively, you can run yarn run lint in a terminal window and it will auto correct incorrect code when you save.

Copyright

2020 © SchoonLabs