start-vue-project

A CLI tool to quickly scaffold a Vue 3 project with Vite, TypeScript, Tailwind CSS, and other useful configurations for development and deployment.

This project is currently in early development, so dont use it in production yet. The API may change without warning, and there may be bugs or incomplete features. Contributions and feedback are welcome!

Usage

To use the CLI tool, run the following command in your terminal:

npx start-vue-project my-vue-app

This will create a new Vue 3 project in the directory you specify with the following features (some features are optional and can be enabled during setup):

• Vite as the build tool
• TypeScript for type safety
• Tailwind CSS for styling
• VS Code Devcontainer configuration
• Makefile with build and development commands
• Bun as the JavaScript runtime
• Oxlint for code quality
• Commitlint for commit message linting
• Oxfmt for code formatting
• GitHub Actions workflows for CI/CD
• Semantic Release for automated versioning and publishing
• Skills and Agent.md for advanced automation
• A README file with instructions for development and contribution
• A LICENSE file for open source projects

Most of the configuration files are generated from templates, allowing you to easily customize them to fit your specific needs.

Development

To develop the CLI tool, clone this repository and run the following command to install dependencies:

make install

You can then run the CLI tool locally with:

make dev

This will start the CLI tool in development mode, allowing you to make changes and test them immediately.

Contributing

Contributions to this project are welcome! If you have any ideas for improvements or new features, please open an issue or submit a pull request. Make sure to follow the existing code style and include tests for any new functionality.

License

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