Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kylelogue/mustard-ui
A starter CSS framework that actually looks good.
https://github.com/kylelogue/mustard-ui
css css-framework scss scss-framework
Last synced: 24 days ago
JSON representation
A starter CSS framework that actually looks good.
- Host: GitHub
- URL: https://github.com/kylelogue/mustard-ui
- Owner: kylelogue
- License: mit
- Created: 2018-03-24T13:54:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T00:54:52.000Z (almost 2 years ago)
- Last Synced: 2024-10-02T03:20:21.986Z (about 1 month ago)
- Topics: css, css-framework, scss, scss-framework
- Language: SCSS
- Homepage: https://kylelogue.github.io/mustard-ui
- Size: 693 KB
- Stars: 1,028
- Watchers: 34
- Forks: 64
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-CSS-Resources - mustard ui:
README
# [Mustard UI](https://kylelogue.github.io/mustard-ui)
Mustard is a **starter CSS framework** that actually looks good.
[](https://www.npmjs.com/package/mustard-ui)
[](https://www.npmjs.com/package/mustard-ui)
## Getting Started
Mustard UI is currently in release v1.0. Try it out today and help us fine tune the look and feel for future versions!
To get started, you can follow our [Installation Guide](https://kylelogue.github.io/mustard-ui/docs/installation) or use one of the methods provided below:
**Install Using NPM:**
```bash
npm install mustard-ui
```
**Include via a CDN::**
```html
```
**Clone the Repo and Install Dependencies:**
```bash
git clone https://github.com/kylelogue/mustard-ui.git
```
**Re-build the SCSS files:**
```
npm run build
```
**Open the Sandbox Environment:**
```
npm run dev
```
You can start configuring the colors to suit your needs by first changing the `$brand-color` variable located in `src/scss/base/base.scss` from `$color-green-500` to `$color-indigo-500` or any other color you'd like. There are lots of colors that can be found in the `src/scss/vars/colors.scss` file.
## CSS Only
Mustard is a CSS framework and does not include any javascript. We do this in an effort to keep the filesize small.
You can use the framework as is or customize it via the component variables located at the top of each component scss file.
## Documentation
Full documentation is provided on our website located on this repositories [GitHub Page](https://kylelogue.github.io/mustard-ui) and also located in the `/docs` folder as static html.
## Become a Contributor
Mustard UI is provided free of cost because of the contributions that are made from developers like you. If you'd like to see this project grow, we would love it if you could submit a pull request to the project on GitHub.
## Copyright and License
Copyright 2018 Kyle Logue. This project is licensed under the MIT License.