@khalyomede/star-dust
v0.1.0
Published
CSS Framework based on Material Design guidelines.
Downloads
1
Readme
Star Dust
CSS Framework based on Material Design guidelines.
Summary
About
Star Dust is my attempt of making a modular CSS framework based on Material Design guidelines. Those design principles are clear, because they address an issue from A to Z. Theyt are consistant, with a single design line accross a bunch of components. These principles are conscise, which promotes information destructuration and other modern UX improvements for the end user, and they offer a great designer experience with precise guidance (spacing, design choices, ...).
Star Dust main target is the web apps, websites, and others platform supporting HTML/CSS.
Advantages
- Flexible: either import the hole css file, or use SASS to code-split your css files.
- Lightweight: If you use SASS, you can greatly reduce the number of unused CSS.
- Hackable: Use of variables let you customize every component at a very fine grain.
- Easily integrable: Each components is under the
sd
"namespace" (e.g. class), which does not interfer with other frameworks.
Installation
CDN
Available soon.
NPM
Available soon.
Usage
Available soon.
Contributing
Project architecture explained
- Star Dust is using Gulp.js for building its components.
- The build command is available using:
npm run build
. - You can start a development program for continuous build:
npm run start
. It will listen changes so you do not have to run the build command manually. - Actually, I prefer using Yarn for the command above because I can see a cute little cat besides my
yarn.lock
file 🐱 (and also for the speed) - Stylesheets are managed using SASS (and then built to CSS via the build command).
- Star Dust uses StyleLint, in order to keep some code consistancy.
- This project is being tested using BrowserStack, so I can stay in line with the most devices possible. BrowserStack is making this project so much more reliable by providing a tons of available devices, from smartphones to multiple browsers, across iOS, Windows, and plenty more, so make sure to check their offer!
Where I need you
First, just have fun with your pull requests. I need this to be a pleasant occasion to help the project. Just thinking how much time you spent on the PR is making me so happy, so do not hesitate, even if it is a one character typo!
- Finding a CI tool (Travis?)
- Finding a test tool for end-to-end testing
- Finding a documentation generator (or something that let us manually publish updates)
Have fun guys!