https://github.com/seyd/spot-css

SPOT CSS Framework { Single Place Of Truth Methodology }
https://github.com/seyd/spot-css

css css-architecture css-framework css-methodologies css-methodology sass sass-architecture sass-framework sass-mixins

Last synced: 28 days ago
JSON representation

SPOT CSS Framework { Single Place Of Truth Methodology }

• Host: GitHub
• URL: https://github.com/seyd/spot-css
• Owner: seyd
• License: mit
• Created: 2020-02-13T12:21:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-09T11:25:57.000Z (about 1 year ago)
• Last Synced: 2024-10-02T03:21:19.256Z (about 1 month ago)
• Topics: css, css-architecture, css-framework, css-methodologies, css-methodology, sass, sass-architecture, sass-framework, sass-mixins
• Language: SCSS
• Homepage:
• Size: 615 KB
• Stars: 25
• Watchers: 4
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

      

      

      

    

  





    

    

    

    



  

  The ultimate SASS framework and CSS methodology for sustainable styling.


  A clear and semantic way to write CSS.


  Aspiring industry standard for writing styles.



------




## What is it about?

SPOT CSS is a pure SASS framework and is primarily about the structure of CSS code. It is forcing component base approach and relies on maximum semantic code.

If you don't like the approach of utility first frameworks like Tailwind and you don't want to write inline styles on steroids, which is easy to write, but damn hard to read and maintain, this is the framework for you.






  

    

      

      

      

    

  



You can play with the live demo here: [spotcss.io](https://spotcss.io/)







## Installation

Run `$ npm i --save-dev spotcss` or `$ yarn add --dev spotcss` to install SPOT CSS package.

Include line `@import "~spotcss";` into your SCSS/SASS files.




## Documentation

We offer 4 ways to explain our methodology and framework:

- **[Cheat Sheet](https://spotcss.io/cheat-sheet)** - `takes 3 minutes` - Select what you want to do and find out how to do it in SPOT CSS framework.

- **[Quick start guide](https://spotcss.io/quick-start-guide)** - `takes 15 minutes` - The quickest way to see the way style is written in this framework, without explanation of why it is so and what are the advantages of such an approach.

- **[Tutorial](https://spotcss.io/tutorial)** - `takes 1 hour` - A basic overview that is organized so that it can be read from start to end and so that the reader understands the fundamental principles and basic ways of using the framework.

- **[Documentation](https://spotcss.io/docs/intro)** - `takes hours` - Comprehensive documentation of everything, organized by mixins and framework entities, so you can quickly find exactly what you want to learn more about.

Choose the one that fits your current needs best.




## Pros

### Clear to read

Even those who are not familiar with our methodology and framework understand the written code, because it has an intuitive syntax.

### Easy to write

Because every line has a clear meaning and context, you can learn syntax very quickly and parser will help you not to break the rules.

### Natural to think that way

You are already thinking in term of components, elements, states, variants an contexts. Just write and read it just like that.

### Just SASS

Pure SASS framework with no other dependencies, javascript, or pre/post processor. So it's usable in any ecosystem (JS, PHP, Rubby, Python...)




## Cons

### SASS syntax

Everyone uses the SCSS syntax. So why SASS? Because of @include. But you can use the SCSS syntax if you want. But it's ugly and cluttered. See [the differences](https://spotcss.io/docs/sass-syntax).

### New mixins

SPOT CSS code is based on mixins and functions. Most of them produce selectors. It's easy to learn because they are semantic. See the [Quick start guide](https://spotcss.io/quick-start-guide).

### No utility classes

If you are used to using utility classes exclusively, this approach is different. It is component based. But you can use utility classes sometimes, but in moderation.

### Too strict

SPOT CSS framework forces you to follow many rules and will yell at you when you break some of them. But that's the advantage, it's basically an implicit linter. You can get around partially this with +mode('draft').




## Other benefits

### Universal

The SPOT CSS approach is compatible with most types of projects and methodologies. Even with BEM. What it is not compatible with is utility first class frameworks.

### Standardized

With SPOT CSS basically everyone writes the same code. Or at least very similar. Therefore, it can serve as a company standard for how to structure and write CSS.

### Easy to refactor

If your project is written as component based CSS, but over time you've gotten into an unmaintainable state, refactoring to SPOT CSS is a matter of a few days.




## Community

### Discord

Join our SPOT CSS community and enjoy our prompt support on [Discord](https://discord.gg/cyCXkZmJzm).

### Looking for contributors

If you are interested in any of this and you know how to code in JS or SASS, we can make amazing and useful tools together. I'm on my own for now on this project and any help will be appreciated. Contact me on our [Discord](https://discord.gg/cyCXkZmJzm) - Johnny Seyd (@Seyd#6245)




## License

The SPOT CSS Framework and methodology is released under the [MIT License](https://github.com/seyd/spot-css/blob/master/LICENSE).