An open API service indexing awesome lists of open source software.

https://github.com/maximedaraize/create-scss-cli

🧰 CLI for a quick and easy way to structure your scss with multiple templates available
https://github.com/maximedaraize/create-scss-cli

cli css sass scaffold scss starter-project templates

Last synced: 10 months ago
JSON representation

🧰 CLI for a quick and easy way to structure your scss with multiple templates available

Awesome Lists containing this project

README

          

![create scss logo](https://res.cloudinary.com/mdaraize/image/upload/c_scale,h_200/v1633914336/create-scss-cli/logo.png)

# CREATE SCSS CLI

![npm version](https://img.shields.io/npm/v/create-scss-cli)
![npm license](https://img.shields.io/npm/l/create-scss-cli?color=%2321bab3)
![npm downloads](https://img.shields.io/npm/dt/create-scss-cli)
![npm publish](https://img.shields.io/github/workflow/status/maximedaraize/create-scss-cli/publish)

A command-line interface for a quick and easy way to organize your scss.

Generate an scss folder structure anywhere you want in your application.
Choose which template you want to use (complete, clean, custom). Manage your file the same way in every project, and save time doing it.


## Documentation

To learn more about **create-scss-cli**, visit [createscss.com](https://www.createscss.com/)

## Table of Contents

1. [Installation](#installation)
2. [Structure](#structure)
3. [Contribution and support](#contribution)

## Installation

### Prerequisites

- [Node 14](https://nodejs.org/en/)
- [Npm](https://www.npmjs.com)

You can install the package globally or execute it right away with npx.

### Global install

```sh
npm i -g create-scss-cli
```

After that, you'll be able to use the create-scss-cli command in your project loke so:

```sh
cs-cli
```

### NPX

```sh
npx create-scss-cli
```

You will then be prompt with a series of questions to make sure the cli generate the files you want and where you want them.

create-scss-cli setup example

## Structure

```bash
scss

├── abstracts
│   ├── colors
│   ├── fonts
│   ├── index
│ ├── mixins
│   ├── spacing
│   └── helper

├── base
│   ├── global.scss
│   ├── shame.scss
│   └── typography.scss

├── components
│   ├── alert.scss
│ ├── banner.scss
│   ├── buttons.scss
│   ├── card.scss
│   ├── forms.scss
│   ├── icons.scss
│   ├── menu.scss
│   ├── modal.scss
│   ├── progress.scss
│   └── table.scss

├── layout
│   ├── footer.scss
│   ├── grid.scss
│   ├── header.scss
│   ├── navigation.scss
│   └── sidebar.scss

├── pages
│   └── home.scss

├── themes
│   └── dark.scss

├── vendor
│   └── normalize.scss

└── main.scss
```

## Contribution

If you want to contribute to this project go to the [create-scss-cli](https://github.com/maximedaraize/create-scss-cli/issues) repo and open an issue ✏️

Show your support by giving a ⭐️ on [Github](https://github.com/maximedaraize/create-scss-cli)

## 🙋‍♂️ Author

#### Maxime Daraize

[Github](https://github.com/maximedaraize/)

[NPM](https://www.npmjs.com/package/create-scss-cli)

[Email](mailto:hello@maximedaraize.com)