Skip to content

Sapl - The Sass Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites

License

Notifications You must be signed in to change notification settings

nusalab-studios/sapl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sapl - The Sass Boilerplate

Build Status License GitHub issues GitHub stars GitHub forks

Sapl - The Sass Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.

  • Sass with Gulp : Here
  • Sass with Grunt : Here
  • Sass with Webpack : Here

Architecture Sass

Properly architecting your Sass project is a crucial starting point to having a maintainable, scalable, and well-organized project. Sass makes separating your project into logical “modules” simple with the @import directive, which acts differently than the native CSS @import directive in that it includes .scss or .sass files before the final CSS output.

You can read the documentation on the @import directive to get a good idea of how you can use it to include partial files.

There are many project architectures that you can employ in your project, and each might have their pros and cons. The important thing is that you choose one and stick with it. In this article, The 7-1 Pattern by Hugo Giraudel will be used. To summarize, there are seven folders and one main.scss file for output:

  • base/ – contains global styles, such as resets, typography, colors, etc.
  • components/ – contains each self-contained component in its own .scss partial
  • layout/ – contains styling for larger layout components; e.g. nav, header, footer, etc.
  • pages/ – contains page-specific styling, if necessary
  • themes/ – contains styling for different themes
  • utils/ – contains global mixins, functions, helper selectors, etc.
  • vendors/ – contains 3rd-party styles, mixins, etc.
  • main.scss – output file that brings together all of the above parts

Reference : scotch.io

How to contribute

I'm delighted that you're helping make this open source project better. Here are a few quick guidelines to make this an easier and better process for everyone.

Reporting a bug

First, make sure the bug hasn't already been reported by searching GitHub's issues section.

If no existing issue exists, go ahead and create one. Please be sure to include all of the following:

  1. A clear, descriptive title (ie. "A bug" is not a good title).
  2. Include the error message if have.
  3. The browser and OS that you're using.

Submitting a Pull Request

  1. Fork it
  2. Create your feature branch git checkout -b new-feature
  3. Commit your changes git commit -m "Add some feature"
  4. Push to the branch git push -u origin new-feature
  5. Create new Pull Request

License

MIT © Nusalab Studios