4 releases
0.2.0 | Oct 12, 2023 |
---|---|
0.1.2 | Aug 19, 2023 |
0.1.1 | Aug 18, 2023 |
0.1.0 | Aug 18, 2023 |
#864 in Web programming
29 downloads per month
52KB
1K
SLoC
EasyWind
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
# 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
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 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
Initialize a new project
Usage: easywind init <PROJECT_NAME>
Arguments:
<PROJECT_NAME>
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
Start the server and tailwind watcher
Usage: easywind start [OPTIONS] [ROOT_DIR]
Arguments:
[ROOT_DIR] [default: .]
Options:
-p, --port <PORT> Port the server shoud use, defaults to 3500 [default: 3500]
-O, --open Open in your browser
-i, --input <INPUT> Input css file to process
-o, --output <OUTPUT> Where you want the final CSS file to be written
-h, --help Print help
easywind serve
Run a live reloading server to serve content
Usage: easywind serve [OPTIONS] [ROOT_DIR]
Arguments:
[ROOT_DIR] [default: .]
Options:
-p, --port <PORT> Port the server shoud use, defaults to 3500 [default: 3500]
-o, --open Open in your browser
-h, --help Print help
easywind tailwind
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>
Input css file to process
[default: src/app.css]
-o, --output <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')
Dependencies
~18–31MB
~497K SLoC