create-vitewind
v1.0.6
Published
A CLI tool to generate a starter project with Tailwind CSS, Vite, prettier and eslint
Downloads
9
Maintainers
Readme
ViteWind
ViteWind is a command-line utility that generates a starter project code for modern frontend frameworks. It is built using Node.js and is available as an npm package. It also supports both JavaScript and TypeScript.
Requirements
- Node.js (version 14 or higher)
- npm (version 7 or higher)
Usage
You can use it to generate a new project by running the following command in your terminal:
npm create vitewind@latest
Features
- Select from a list of templates to generate a project code.
- Supports both JavaScript and TypeScript.
- Supports React, Vue, Svelte, and Vanilla too.
- Uses Vite as the build tool.
- Uses TailWind CSS as the styling framework.
- Uses ESLint for code linting.
Command Line Interface
When running the 'npm create vitewind@latest'
command, the following steps will be executed:
- Welcome message: Displays a welcome message and introduces the utility.
- Project name: Prompts you to enter the name for your project. The default name is
"vitewind-app"
- Choose Framework: Prompts you to choose a framework for your project. The default framework is
"Vanilla"
- Choose Language: Prompts you to choose a language for your project. The default language is
"JavaScript"
- Guidelines: Provides instructions on how to start your project, including changing to the project directory, installing dependencies, and running the development server.
- Nice shape: Displays the "ViteWind" title in a stylized ASCII art format.
Acknowledgements
ViteWind is built using various open-source libraries and tools. We acknowledge and appreciate the hard work put into creating and maintaining these dependencies.
- Node.js: https://nodejs.org
- Vite: https://vitejs.dev
- Prettier: https://prettier.io
- ESLint: https://eslint.org
- Chalk: https://github.com/chalk/chalk
- Figlet: https://github.com/patorjk/figlet.js
- Inquirer.js: https://github.com/SBoudrias/Inquirer.js
Contributing
Contributions to ViteWind are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. We appreciate your feedback and contributions.
License
ViteWind is licensed under the MIT License.
Contact
If you have any questions or need further assistance, you can reach out to us at: