Skip to content

chriswburke/sass-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sass Boilerplate

Build Status

Features

  • CSS Autoprefixing
  • Built-in preview server with BrowserSync
  • Compile Sass with libsass
  • Documentation with sassdoc

Notes on libsass

Keep in mind that libsass is feature-wise not fully compatible with Ruby Sass. Check out this curated list of incompatibilities to find out which features are missing.

Getting Started

  • Clone this repo!
  • Install dependencies: npm install
  • Run npm run serve to preview and watch for changes
  • Run npm run build to build your sass for production

Project Structure

The project structure is based on the Sass 7-1 Pattern. Checkout sass guidlines for a detailed overview. The key difference in this structure is that we've given variables their own directory. Managing variables in a large project can get pretty crazy so to make things easier to maintain, we separate them by type.

Project Root/
β”‚
β”œβ”€β”€ build/
β”‚   β”œβ”€β”€ css/
β”‚   β”‚     └── main.css
β”‚   β”‚     └── print.css
β”œβ”€β”€ src/
β”‚   └── sass/
β”‚       β”œβ”€β”€ base/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _fonts.scss
β”‚       β”‚   └── _iconograpy.scss
β”‚       β”‚   └── _typography.scss
β”‚       β”‚   
β”‚       β”œβ”€β”€ components/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _buttons.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ layout/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _footer.scss
β”‚       β”‚   └── _grid.scss
β”‚       β”‚   └── _header.scss
β”‚       β”‚   └── _navigation.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ pages/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _home.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ themes/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _default.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ utils/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _functions.scss
β”‚       β”‚   └── _helpers.scss
β”‚       β”‚   └── _mixins.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ variables/
β”‚       β”‚   └── _all.scss
β”‚       β”‚   └── _breakpoints.scss
β”‚       β”‚   └── _colors.scss
β”‚       β”‚
β”‚       β”œβ”€β”€ vendor/
β”‚       β”‚   └── _all.scss
β”‚       β”‚
β”‚       β”‚
β”‚       └── main.scss
β”‚       └── print.scss
β”‚
β”œβ”€β”€ docs/
β”‚
β”œβ”€β”€ node_modules/
β”‚
β”œβ”€β”€ .editorconfig
β”œβ”€β”€ .gitignore
β”œβ”€β”€ package.json
└── README.md

##TODO

  • SCSS Linting
  • Source Maps for Development

License

MIT license

About

Sass Boilerplate for large projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages