Coder Social home page Coder Social logo

claudiusayadi / ketocss Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.88 MB

The #1 variable-first atomic design framework! This is my personal CSS Framework or project starter kit based on SASS (SCSS) and CSS Variables.

JavaScript 4.07% SCSS 94.81% HTML 1.12%
css-framework cssnano ecommerce modern-css-features postcss postcss-preset-env postcss-sass responsive-design sass sass-starterkit

ketocss's Introduction

KetoCSS

The super-performant, variable-based, mobile-first, stack-agnostic (refactoring towards React since its my main stack now), lean atomic design framework!


This is my personal CSS Framework or project starter kit based on SASS (SCSS) and CSS Variables. This Framework is heavily inspired by ACSS (Automatic CSS by Kevin Geary). It is the second version of my former SASS Starter Template. It simply shows my learning growth. So, it will always be a WIP (work-in-progress).

This framework is meant to express simplicity and speed, helping devs to quickly start designing their apps in no time.

If you are here, I would love your contributions no matter how little. The goal is to have a flexible CSS Framework that gives us needed utility classes without clogging up our HTML like TailwindCSS, and still allows unlimited freedom to use custom BEM classes powered by the keto-variables.

FEATURES

The framework includes classes for common CSS rules (e.g. grids, flex, column-counts, buttons, font-related classes, etc.), and tons of readily available CSS variables for nearly every property you would need in your projects - global (root) and local (element, e.g. buttons) scoped.

Best of it, KetoCSS automatically generates all your color tints, shades, and transparent variants, and gives you a well-balanced theme to work with.

This is a work in progress. If you notice any bug, please let me know All suggestion and feature requests are welcomed too.

GETTING STARTED

  1. Clone the repo or download the zip file and extract it.
  2. Copy the package.json and the postcss.config.cjs to your project root.
  3. Move the keto folder into your project /src and delete everything else here.
  4. Install all dependencies:
yarn
  1. Customize and make it yours:

You have two files to edit here (These are the only files you should modify).

edit the variables in _global.scss
edit _fonts.scss and copy your fonts into the fonts folder
import "./keto/keto.scss" into your main.jsx or layout.jsx
  1. Start up your project:
yarn dev
  1. Build away ๐ŸŽ‰

PostCSS handles everything and you don't have to do any extra configuration.

You can use npm or pnpm too.


NOTE: PurgeCSS ensures that only used classes are compiled in the final build.

I assume you use Vite.js for all your React project. The setup is the same for Next.js

Always check back for the newest updates. I'm working on creating React components based on the framework that anyone can easily copy and use.

Want to contribute? Let me know, please.

ketocss's People

Contributors

claudiusayadi 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.