cyrildewit/perceptor

My personal CSS boilerplate/framework written in Sass

Perceptor

Modern Sass starter kit that requires you to keep your CSS organized and clean.

Overview

Perceptor is my personal SCSS boilerplate. It's the result of 4 years of finding the right structure that I can use for my personal projects.

Need an compiler? See Perceptor Studio!

Features

• Organized component structure
• Bootstrap 4 grid included
• Sanitize included
• BEM helper mixins (element & modifier)

Note: This project is currently under development. If you have any ideas or tips, please feel free to report that at the issue tracker.

Rules / Conventions

Summary of: https://css-tricks.com/abem-useful-adaptation-bem/

ABEM

[a/m/o]-blockName__elementName -modifierName

camelCase

/* classic + atomic prefix */
.o-subscribe-form__field-item {}

/* camelCase + atomic prefix */
.o-subscribeForm__fieldItem {}

Seperated modifier

/* classic */
.block-name__element-name--green {
  background: green;
  color: white;
}

/* seperated modifier */
.a-blockName__elementName.-green {
  background: green;
  color: white;
}

Utilities

u-utilityName

No Sass placeholders

Don't use Sass placeholder! Instead use mixins.

https://www.sitepoint.com/avoid-sass-extend/

Example SCSS structure

.
├── 00_abstracts
|   ├── mixins
|       ├── _bem.scss
|       ├── _clearfix.scss
|       ├── _hover.scss
|   ├── _functions.scss
|   ├── _variables.scss
├── 01_base
|   ├── _fonts.scss
|   ├── _generic.scss
|   ├── _sanitize.scss
├── 02_atoms
|   ├── _button.scss
|   ├── _card.scss
|   ├── _panel.scss
├── 03_molecules
|   ├── _typography.scss
|   ├── _lists.scss
|   ├── _image.scss
├── 04_organisms
|   ├── _bootstrap-grid.scss
|   ├── _site-header.scss
|   ├── _section.scss
|   ├── _site-footer.scss
├── 05_templates
|   ├── _home.scss
|   ├── _week-action.scss
├── 06_pages
|   ├── _home.scss
|   ├── _week-action.scss
├── 07_utilities
|   ├── _clearfix.scss
├── 08_vendor
|   ├── _clearfix.scss

Organizing

• 00_abstracts
  • Sass tools, helpers, global variables, functions, mixins.
• 01_base
  • Boilerplate code; reset, global typographic rules, generic standard styles.
• 02_atoms
• 03_molecules
• 04_organisms
• 05_templates
• 06_pages
• 07_utilities
• 08_vendor

To do

Read:

• https://medium.com/codyhouse/create-your-design-system-part-2-grid-layout-aa961d59b8d6
• https://medium.com/codyhouse/create-your-design-system-part-1-typography-7c630d9092bd
• https://ether.thescenery.co/spacing/
• http://thesassway.com/beginner/how-to-structure-a-sass-project
• https://www.sitepoint.com/architecture-in-sass/
• https://github.com/steveosoule/atomic-design-sass-outline/tree/master/stylesheets
• https://blog.alexdevero.com/atomic-design-scalable-modular-css-sass/
• https://webdesign.tutsplus.com/articles/structuring-sass-saying-goodbye-to-atomic-design-ambiguity--cms-26679
• https://css-tricks.com/lets-define-exactly-atomic-css/
• http://atomicdesign.bradfrost.com/chapter-2/
• https://www.lullabot.com/articles/bem-atomic-design-a-css-architecture-worth-loving
• https://css-tricks.com/abem-useful-adaptation-bem/
• https://www.sitepoint.com/introducing-ccss-component-css/
• https://www.sitepoint.com/introducing-ccss-component-css/
• https://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/

Credits

• Cyril de Wit - Initial work - cyrildewit

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.