Giter Site home page Giter Site logo

remco-freshheads / maatcss Goto Github PK

View Code? Open in Web Editor NEW

This project forked from freshheads/maatcss

0.0 1.0 0.0 398 KB

Extensible and scalable sass-based modules that can be used as a starting point for UI projects

License: MIT License

CSS 42.48% Shell 3.60% JavaScript 4.50% HTML 49.42%

maatcss's Introduction

Maat.css

Extensible, scalable, Sass-based modules that can be used as starting point for UI projects

The maat.css modules do not provide you with UI and design out of the box, instead, it provides you with a solid architectural baseline upon which to complete your own work. Every module can be replaced, ignored or extended so it doesn't limit you when new strategies or technologies arise.

Features

  • BEM
  • Flexbox layouts
  • Custom breakpoints
  • Rem based font sizes
  • Basic form styling with custom checkboxes, radios and selects
  • Guidelines for your project structure (can be diverged from, this is not the holy grail)

Installation

Add the maat.css package to your package.json.

npm install @freshheads/maatcss

Usage

Once you have the maat.css in your project you first need to copy the example.main.scss file into your project directory structure and rename this to your application entry point. This file accesses the maat.css modules, and you can extend it with your own UI component modules.

The imports in this file need to be changed to the location of the maat.css node module. e.g. '~maatcss/generic/toplevel' when using Webpack.

Directory structure guidelines

Maat.css follows a specific directory structure, which you hopefully follow as well in your own CSS directory:

  • /settings: Global variables, site-wide settings, transcending component settings.
  • /tools: Site-wide mixins and functions.
  • /generic: Low-specificity, far-reaching rulesets (e.g. resets, typography, wrappers).
  • /layout: Our own flexbox based grid.
  • /components: BEM minded, independent blocks of UI. A few essentials are provided e.g. forms and buttons.
  • /utilities: High-specificity, very explicit selectors. Overrides and helper classes. You can use tools to create them.

Module specific guidelines

Maat.css documentation

Development

Start a local server using webpack >=2 and webpack-dev-server

npm install
npm run start

maatcss's People

Contributors

gvdlangenberg avatar martinbroos avatar remco-freshheads avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.