Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipuppyyt/tailwind-vite
A vite package preconfigured with tailwindcss, with added option for SCSS
https://github.com/ipuppyyt/tailwind-vite
cli create-tailwind-vite css javascript npm npm-cli npm-package npmjs scss swc tailwindcss template typescript vite
Last synced: about 1 month ago
JSON representation
A vite package preconfigured with tailwindcss, with added option for SCSS
- Host: GitHub
- URL: https://github.com/ipuppyyt/tailwind-vite
- Owner: ipuppyyt
- License: mit
- Created: 2024-11-04T04:27:12.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-14T11:49:14.000Z (about 2 months ago)
- Last Synced: 2024-12-22T04:07:39.381Z (about 2 months ago)
- Topics: cli, create-tailwind-vite, css, javascript, npm, npm-cli, npm-package, npmjs, scss, swc, tailwindcss, template, typescript, vite
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/create-tailwind-vite
- Size: 244 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tailwind Vite
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
```arduino
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](https://nodejs.org/) installed on your machine (version 18 or higher).
### Usage
You can use it directly with `npx`:
```bash
npx tailwind-vite
```
or
```bash
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:
```bash
npx tailwind-vite
```
or
```bash
npm create tailwind-vite
```
- Follow the prompts to set up your project.
- Navigate into your project directory:
```bash
cd your-project-name
```
- Install dependencies:
```bash
npm install
```
- Start your development server:
```bash
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
- [Vite](https://vite.dev/)
- [Tailwind CSS](https://tailwindcss.com/)
- [SCSS](https://sass-lang.com/)