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

https://github.com/tagtwp/gulp-tailwindcss

Gulp with Tailwindcss for a quick development start. Automated build simplifies development, letting focus on quality code.
https://github.com/tagtwp/gulp-tailwindcss

Last synced: 2 months ago
JSON representation

Gulp with Tailwindcss for a quick development start. Automated build simplifies development, letting focus on quality code.

Awesome Lists containing this project

README

        

gulp-tailwindcss Stars Badge
===

Gulp with Tailwindcss for a quick development start. Automated build simplifies development, letting focus on quality code.

Installation
---------------

### Requirements

`gulp-tailwindcss` requires the following dependencies:

- [Node.js](https://nodejs.org/)
- [Gulp.js](https://gulpjs.com/)

### Quick Start

To work with this build, clone the entire contents of the repository using:

`git clone `

After cloning, navigate to the main project folder and run the following command to install all necessary dependencies specified in the package.json file:

```shell
npm install
```

Once the dependencies are installed, you can use any of the available build commands. The resulting files will be placed in the `dist` folder in the root directory:

```shell
npm run dev
```
The base command that starts the build process for development.

```shell
npm run build
```
Builds the project, optimizing and compressing all files for hosting.

```shell
npm run clean
```
Run this command for clean folder dist and .temp .

```shell
npm run deploy
```
Creates a temporary clone of the current repository, generates a gh-pages branch if it doesn't already exist, copies all files from the base path (or those matching patterns from the optional src configuration), commits all changes, and pushes to the origin remote.

### πŸ“ Folder and file structure
```
β”œβ”€β”€ dist/ # This folder after build
β”œβ”€β”€ src/ # Sources
β”‚ β”œβ”€β”€ assets # Assets folder
β”‚ β”‚ β”œβ”€β”€css # Css folder
β”‚ β”‚ β”œβ”€β”€images # Images folder
β”‚ β”‚ β”œβ”€β”€js # Scripts folder
β”‚ β”‚ β”œβ”€β”€fonts # Fonts folder
β”‚ β”‚ β”œβ”€β”€tcss # Tailwindcss folder
β”‚ β”‚ β”‚ β”œβ”€β”€custom # Custom style tailwindcss
β”‚ β”‚ β”‚ β”œβ”€β”€style.css # Main style file tailwindcss
β”‚ β”œβ”€β”€ partials # Folder for storing html partials of the page
β”‚ β”‚ β”œβ”€β”€ components # Folder for storing html components of the page
β”‚ β”‚ β”œβ”€β”€ head.html # Head for include style, script, font and more
β”‚ └── index.html # Main html file
└── gulpfile.babel.js # Gulp configuration file
└── package.json # file with build settings and installed packages
└── .editorconfig # file with code formatting settings
└── .ecrc # editorconfig-checker package settings file (excludes unnecessary folders)
└── .prettierrc # Prettier settings file
└── README.md # README build
```