tituskirch/tailwind-post-scss-template

A basic tailwindcss + PostCSS + node-sass template.


README

A basic tailwindcss + PostCSS + node-sass template.

Build action status License Packagist Downloads Contributors Discord

Table of contents

About the project

This project is a very simple template to start with a tailwindcss project (including SCSS compiler).

Getting started

First you have to install npm. Installation instructions

Than you have to install composer. Installation instructions

Require the project:

composer require tituskirch/tailwind-post-scss-template

Now install all required resources:

composer install
npm install

Ready! Now you can start with your project.

Howto

To convert your SCSS code under /scss/app.scss to CSS code use the following command:

npm run build

Afterwards your CSS code is created under /public/css/app.css.

Alternatively you can also use the following command:

npm run watch

This will execute npm run build after each change.

Contributing

There are many ways to help this open source project. Write tutorials, improve documentation, share bugs with others, make feature requests, or just write code. We look forward to every contribution.

Versioning

We use SemVer for versioning. For available versions, see the tags on this repository.

Built with

  • node-sass - Node.js bindings to libsass
  • nodemon - Monitor for any changes in your node.js application and automatically restart the server - perfect for development
  • PostCSS CLI - CLI for postcss
  • postcss-import - PostCSS plugin to inline @import rules content
  • tailwindcss - A utility-first CSS framework for rapid UI development.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.