An open API service indexing awesome lists of open source software.

https://github.com/vxtool/prime-itcss

CSS structure with metodology ITCSS for concentration of multiple projects
https://github.com/vxtool/prime-itcss

css itcss less prime scss stylus

Last synced: 25 days ago
JSON representation

CSS structure with metodology ITCSS for concentration of multiple projects

Awesome Lists containing this project

README

          

# Prime ITCSS

[![licence mit](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](http://hemersonvianna.mit-license.org/)
[![GitHub issues](https://img.shields.io/github/issues/vxtool/prime-itcss.svg)](https://github.com/vxtool/prime-itcss/issues)
![GitHub package.json version](https://img.shields.io/github/package-json/v/vxtool/prime-itcss.svg)
![GitHub Release Date](https://img.shields.io/github/release-date/vxtool/prime-itcss.svg)
![GitHub top language](https://img.shields.io/github/languages/top/vxtool/prime-itcss.svg)
![GitHub repo size](https://img.shields.io/github/repo-size/vxtool/prime-itcss.svg)
![GitHub All Releases](https://img.shields.io/github/downloads/vxtool/prime-itcss/total.svg)

## Translations

* [Portuguese - Brazil](translations/pt_BR)

## 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](http://itcss.io/) and syntax [SCSS](http://sass-lang.com/), [STYLUS](https://learnboost.github.io/stylus/) and [LESS](http://lesscss.org/).

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](https://github.com/vxtool/prime-itcss/releases) for detailed changelog.

## License

[MIT license](http://hemersonvianna.mit-license.org/) © Hemerson Vianna