prios-plugin-scaffolding-tool

Vue Scaffolding Tool

A CLI tool for scaffolding Vue.js plugin projects with Vite. This tool helps you quickly set up a new Vue.js plugin project with a pre-configured development environment, including Vite, Vue Router, Pinia (state management), Tailwind CSS, and more.

Features

• Vue 3: Built for the latest version of Vue.js.
• Vite: Fast and lightweight development environment.
• Tailwind CSS: Pre-configured for rapid UI development.
• Vue Router: Included for easy setup of single-page applications.
• Pinia: Simple and intuitive state management.
• EJS Templating: Customize templates for your scaffolding needs.
• Component Scaffolding: Automatically generate components with PascalCase naming.
• CI/CD Support: Integrated continuous integration and deployment pipeline for automated testing and deployment.
• Customizable: Easily extendable with options for additional plugins and features.

Installation

Install the package:

npm install -g prios-plugin-scaffolding-tool

Usage

You can generate a new Vue plugin project using the CLI tool.

scaffold prios my-awesome-plugin

Follow the prompts to specify the project name, description, and author.

Example

? Project description: A plugin for Vue.js
? Author name: John Doe

This will scaffold a new Vue.js plugin project in the my-awesome-plugin directory with the following structure:

my-awesome-plugin/
├── src/
│   ├── components/
│   │   └── MyAwesomePlugin.vue
│   ├── assets/
│   │   └── tailwind.css
│   ├── router/
│   │   └── index.js
│   ├── store/
│   │   └── index.js
│   └── main.js
├── public/
├── index.html
├── package.json
├── vite.config.js
└── README.md

Development

To start the development server of your new scaffolded project:

cd my-awesome-plugin
npm run dev

This will start a local development server powered by Vite.

Building

To build the project for production:

npm run build

This will create a production-ready bundle in the dist directory.

Customization

Tailwind CSS The tool includes Tailwind CSS by default. You can customize it by editing the tailwind.config.js file and modifying the src/assets/tailwind.css file.

Vue Router and Pinia Vue Router and Pinia are set up for routing and state management, respectively. You can configure routes in the src/router/index.js file and manage state in the src/store/index.js file.

Contributing Contributions are welcome! Please fork the repository and submit a pull request for review.

License This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• Vue.js
• Vite
• Tailwind CSS
• Pinia
• EJS

How to Open an Issue

1. Navigate to the Issues section of the repository.
2. Click on the New issue button.
3. Provide a clear and detailed description of the problem or question.
4. Include any relevant screenshots, error messages, or code snippets to help us understand the issue better.

We will do our best to address your issue as quickly as possible.

Thank you for using our Vue Scaffolding Tool!