salttechno / tailwindcss-boilerplate

Tailwind CSS boilerplate for HTML projects. Bare-bones HTML template with Tailwind CSS, PostCSS, Gulp & Browsersync.
MIT License
20 stars 9 forks source link

Tailwind CSS Boilerplate

Tailwind CSS boilerplate for HTML projects. Bare-bones HTML starter template with Tailwind CSS, PostCSS, Gulp, Browsersync & Imagemin.

The main purpose of this boilerplate is to simplify the configuration of Tailwind CSS for beginners.

How to use this Tailwind CSS Boilerplate

  1. Clone the repository:

    git clone git@github.com:salttechno/tailwindcss-boilerplate.git <YOUR_PROJECT_NAME>
    
    cd <YOUR_PROJECT_NAME>

    Or else simply download boilerplate's zip file from this link.

  2. Install the dependencies:

    # if you are using npm
    npm install
    
    # OR if you are using Yarn
    yarn
  3. Start the development server:

    # if you are using npm
    npm run dev
    
    # OR if you are using Yarn
    yarn run dev

    Now you should be able to see the project running at localhost:3000.

  4. Open ./index.html in your editor (VS Code recommended) and start editing!

Optimizing for production

Tailwind CSS output needs to be optimized for the production use. The development version for the CSS file is almost 4MB which is not good for production websites. Read this for more details. This boilerplate helps you generate the production version of your CSS file easily & quickly.

We have configured purge option for PostCSS & Tailwind CSS. To build optimized version of your custom CSS, simply run:

# if you are using npm
npm run build

# OR if you are using Yarn
yarn run build

For optimizing your images, simply run:

# if you are using npm
npm run build-images

# OR if you are using Yarn
yarn run build-images