Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Latest commit

 

History

History
128 lines (87 loc) · 4.1 KB

readme.md

File metadata and controls

128 lines (87 loc) · 4.1 KB

cover


A zero-configuration cross-platform Node.js based CLI that generates boilerplate code for different tailwind web applications.

separator

  • Simple: One command setup for all your Tailwind CSS web applications
  • Cross-platform: Works on all available operating systems including Linux, macOS, and Windows
  • Support: Five different web frameworks available with Tailwind CSS integration
  • Prettier: Integrate prettier in Next.js, React.js, Gatsby.js & Vue3 with --prettier flag and then easily format the code with npm run format
  • MIT Licensed: Free to use for personal and commercial use.
  • Featured: new-tailwind-app has been featured in CooperPress newsletters, i.e., Node Weekly and JavaScript Weekly that is subscribed by half a million developers..

Note: If you are on Windows, make sure to either use Command Prompt or Windows Powershell to run the CLI.

🚀 Supported Frameworks & Libraries

You can also generate simple HTML, CSS, and JavaScript application with Tailwind integration using new-tailwind-app.

📦 Installation

# install the CLI globally
npm install -g new-tailwind-app

# use it with npx (recommended)
npx new-tailwind-app [app_name] --flag

🚀 Usage

Navigate to the folder you want to have your tailwind web app.

# help section
npx new-tailwind-app --help

# create a basic tailwind app
npx new-tailwind-app [app_name] --basic

# create a next.js tailwind app
npx new-tailwind-app [app_name] --next

# create a next.js tailwind app with prettier
npx new-tailwind-app [app_name] --next --prettier

# create a react.js tailwind app
npx new-tailwind-app [app_name] --react

# create a react.js tailwind app with prettier
npx new-tailwind-app [app_name] --react --prettier

# create a gatsby.js tailwind app
npx new-tailwind-app [app_name] --gatsby

# create a gatsby.js tailwind app with prettier
npx new-tailwind-app [app_name] --gatsby --prettier

# create a vue3 tailwind app
npx new-tailwind-app [app_name] --vue3

# create a vue3 tailwind app with prettier
npx new-tailwind-app [app_name] --vue3 --prettier

# create a laravel tailwind app
npx new-tailwind-app [app_name] --laravel

# if installed globally
new-tailwind-app [app_name] --flag

help section

🎩 Demo

# if you have installed globally
new-tailwind-app

creates tailwind app

# set up a basic tailwind app using npx
npx new-tailwind-app@latest [app_name] --basic

creates tailwind app

# sets up next.js tailwind app using npx
npx new-tailwind-app@latest [app_name] --react

creates next.js tailwind app

👨🏻‍💻 Contributing

Make sure you read the contributing guidelines before opening a PR. If you want something else to integrate with the CLI, open an issue in the repository and I will get back to it.

⚡️ Other Projects

I have curated a detailed list of all the open-source projects I have authored. Do take out a moment and take a look.

🔑 License & Conduct