Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avencera/easywind
A complete quickstart CLI for Tailwind
https://github.com/avencera/easywind
dev-tools developer-tools hacktoberfest livereload-capabilities livereload-server starter tailwind-css tailwindcss
Last synced: about 2 hours ago
JSON representation
A complete quickstart CLI for Tailwind
- Host: GitHub
- URL: https://github.com/avencera/easywind
- Owner: avencera
- License: apache-2.0
- Created: 2023-08-12T14:06:47.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-07T16:44:36.000Z (11 months ago)
- Last Synced: 2024-09-19T07:42:35.061Z (8 days ago)
- Topics: dev-tools, developer-tools, hacktoberfest, livereload-capabilities, livereload-server, starter, tailwind-css, tailwindcss
- Language: Rust
- Homepage:
- Size: 7.92 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyWind [](https://github.com/avencera/easywind/actions?query=workflow%3A%22Mean+Bean+CI%22)
## What
EasyWind is a CLI designed to be the easiest way to get started with TailwindCSS for static websites.
EasyWind is a **tailwind project generator**, **tailwind compiler/watcher** and a **livereload server**.
With EasyWind you don't need anything else, no need to download brew, node or even the standalone Tailwind CLI. If you don't have node, EasyWind will download the tailwind cli and use it.
To you get started you only need two commands
```shell
# initialize a new project, with index.html and tailwind.config.js
easywind init new-project
# cd into the new project
cd new-project
# start a livereload server and a tailwind watcher in the same process
easywind start . --open
```
## Who
If you are already using Tailwind with Next.js or any other frontend or backend framework, you probably don't need EasyWind.
EasyWind is designed for people new to HTML/CSS and for people who just want an easy way to make static websites, without any fancy frameworks.
## Install
Install using homebrew (mac and linux):
`brew install avencera/tap/easywind`
or
Install from a github release:
`curl -LSfs https://avencera.github.io/easywind/install.sh | sh -s -- --git avencera/easywind`
or
Install using yarn
`yarn global add easywind`
or
Install using npm
`npm i -g easywind`
or
Install from crates.io (if you already have Rust installed)
`cargo install easywind_cli`
or
Download a release directly from github: [github.com/avencera/easywind/releases](https://github.com/avencera/easywind/releases/)
## Usage
You only need two commands to get started (no dependencies not even node or the tailwind cli):
`easywind init mywebsite` will create a project in a new directory, with a `tailwind.config.js` file and an `index.html` file.
***NOTE:** This command will also download the [standalone tailwindcss cli](https://github.com/tailwindlabs/tailwindcss/releases) if you don't have node on your system.*
`easywind start mywebsite --open` will start the tailwind watcher and a live reloading server
https://github.com/avencera/easywind/assets/1775346/e2b55eec-8875-412e-9324-7e65e6d7086e
### easywind init
```bash
Initialize a new project
Usage: easywind init
Arguments:
Name of the project to initialize
This will be used to create a directory with the same name (usage: easywind init portfolio)
Options:
-h, --help
Print help (see a summary with '-h')
```
### easywind start
```shell
Start the server and tailwind watcher
Usage: easywind start [OPTIONS] [ROOT_DIR]
Arguments:
[ROOT_DIR] [default: .]
Options:
-p, --port Port the server shoud use, defaults to 3500 [default: 3500]
-O, --open Open in your browser
-i, --input Input css file to process
-o, --output Where you want the final CSS file to be written
-h, --help Print help
```
### easywind serve
```shell
Run a live reloading server to serve content
Usage: easywind serve [OPTIONS] [ROOT_DIR]
Arguments:
[ROOT_DIR] [default: .]
Options:
-p, --port Port the server shoud use, defaults to 3500 [default: 3500]
-o, --open Open in your browser
-h, --help Print help
```
### easywind tailwind
```shell
Run the tailwind watcher that generates the CSS
Usage: easywind tailwind [OPTIONS] [ROOT_DIR]
Arguments:
[ROOT_DIR]
Path to the root directory of the project. This is where the `tailwind.config.js` file is located.
Defaults to the current directory
[default: .]
Options:
-i, --input
Input css file to process
[default: src/app.css]
-o, --output
Where you want the final CSS file to be written
[default: dist/app.css]
-w, --watch
Watch for changes in input CSS and recompile the output CSS
-h, --help
Print help (see a summary with '-h')
```