Skip to content

A vite package preconfigured with tailwindcss, with added option for SCSS

License

Notifications You must be signed in to change notification settings

ipuppyyt/tailwind-vite

Repository files navigation

Tailwind Vite

JavaScript TypeScript React Remix Vue.js Nuxtjs Vite SASS TailwindCSS Node.js Version NPM Version License NPM Downloads

An enhanced Vite CLI for quickly setting up frontend projects with popular frameworks like React, Vue, and Svelte. This tool lets you configure JavaScript or TypeScript, CSS, SCSS, and Tailwind options, with everything preconfigured for immediate use. Seamlessly integrate with Git by initializing a repository and connecting to GitHub directly during setup. Ideal for developers seeking a fast, interactive way to scaffold fully optimized projects with Vite’s powerful build system.

Features

  • Quick and easy setup for Vite and Tailwind CSS projects.
  • Supports multiple libraries as in Vite
  • Choose between JavaScript, TypeScript, and SWC variants for optimized builds.
  • Flexible stylesheet options: CSS or SCSS.
  • Prompts for user-friendly interaction during project setup.

Recipe

TAILWIND-VITE/
├── VANILLA
│   ├── JS
│   └── TS
├── VUE
│   ├── JS
│   ├── TS
│   └── NUXT
├── REACT/
│   ├── JS
│   ├── JS + SWC
│   ├── TS
│   ├── TS + SWC
│   └── Remix
└── ... (coming soon)

As of now only React and Vanilla are supported and more recipes will appear overtime.

Getting Started

Prerequisites

Make sure you have Node.js installed on your machine (version 18 or higher).

Usage

You can use it directly with npx:

npx tailwind-vite

or

npm create tailwind-vite

You'll be prompted to enter details such as:

  • Project name: Your desired project name.
  • Library: Choose from React, Vue, Svelte, etc..
  • Variant: Depending on the library chosen, select your preferred one.
  • Stylesheet format: Choose between CSS or SCSS.

Example Workflow

  • Run the command to create your project:

    npx tailwind-vite

    or

    npm create tailwind-vite
  • Follow the prompts to set up your project.

  • Navigate into your project directory:

    cd your-project-name
  • Install dependencies:

    npm install
  • Start your development server:

    npm run dev

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! If you have suggestions for improvements or feature requests, feel free to open an issue or submit a pull request.

Acknowledgements