Skip to content

CSS structure with metodology ITCSS for concentration of multiple projects

Notifications You must be signed in to change notification settings

vxtool/prime-itcss

Repository files navigation

Prime ITCSS

licence mit GitHub issues GitHub package.json version GitHub Release Date GitHub top language GitHub repo size GitHub All Releases

Translations

Introduction

With the intention of having a CSS core of several projects in one place. It was created this project to serve as the basis of a front-end project. Using the methodology of ITCSS and syntax SCSS, STYLUS and LESS.

The idea of using the core is when you need more than one project in the same domain. Say in your domain , you need to have the files for site and admin area. Thus, the structure with the core would look like the example below:

>source
 > prime
 > admin
  > style.scss 
 > site
  > style.scss 

With this, in the prime were the tools that will be used in both projects (icons, mixins, functions and more).

Installation

$ npm install @vxtool/prime-itcss

Or add this package to your package.json file:

"dependencies": {
    "@vxtool/prime-itcss": "1.1.3"
  }

And with the dependencies installed , the command default the automator.

Usage

In each project folder, it is not necessary to have some folders (00-settings, 01-tools, 03-generic, 03-base, 04-vendor e 09-trumps), but this is not a rule, you will know the best for your project.

When writing , I am considering that the sample projects (site, admin), they are different and to have this distinction, folders (05-objetcs, 06-components, 07-pages e 08-theme), will be customized for each project.

Recalling once again, the intention is to show the concept that one must have a prime, to avoid repeated code and making it difficult to maintain. The organization of folders in the projects , is at the discretion of the need of the same.

style.scss (site)

@import "../prime/00-settings/_variables";
@import "../prime/01-tools/_mixins";

@import "05-objects/_alerts";

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

Log

Check Releases for detailed changelog.

License

MIT license © Hemerson Vianna