UNPKG

@happyvibess/dev-boost

Version:

๐Ÿš€ Supercharge your development workflow with smart automation

174 lines (133 loc) โ€ข 4.44 kB
# DevBoost ๐Ÿš€ <div align="center"> [![npm version](https://img.shields.io/npm/v/@happyvibess/dev-boost.svg)](https://www.npmjs.com/package/@happyvibess/dev-boost) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Downloads](https://img.shields.io/npm/dt/@happyvibess/dev-boost.svg)](https://www.npmjs.com/package/@happyvibess/dev-boost) ``` _____ ____ _ | __ \ | _ \ | | | | | | _____ _| |_) | ___ ___ ___| |_ | | | |/ _ \ \ / / _ < / _ \ / _ \/ __| __| | |__| | __/\ V /| |_) | (_) | (_) \__ \ |_ |_____/ \___| \_/ |____/ \___/ \___/|___/\__| ``` ๐ŸŒŸ A modern CLI toolkit to supercharge your development workflow with smart automation, project scaffolding, and optimization tools. [Installation](#installation) โ€ข [Features](#features) โ€ข [Usage](#usage) โ€ข [Commands](#commands) โ€ข [Configuration](#configuration) โ€ข [Contributing](#contributing) </div> ## โœจ Features - ๐Ÿ“ฆ **Project Scaffolding**: Generate new projects with modern best practices - ๐Ÿ› ๏ธ **Development Setup**: Automate development environment configuration - โšก **Performance Optimization**: Optimize your project's performance - ๐Ÿ” **Code Quality**: Run comprehensive code quality checks - ๐Ÿ”„ **Workflow Automation**: Streamline your development workflow ## ๐Ÿš€ Quick Demo ```bash # Create a new React project $ devboost scaffold react-app -n my-awesome-app โœจ Creating new React app... ๐Ÿ“ฆ Installing dependencies... ๐ŸŽ‰ Project ready! # Set up development environment $ devboost setup node-env ๐Ÿ”ง Configuring Node.js environment... โœ… Environment ready! # Optimize your project $ devboost optimize bundle ๐Ÿ“Š Analyzing bundle... ๐Ÿš€ Optimization complete! ``` ## ๐Ÿ’ป Installation ```bash npm install -g @happyvibess/dev-boost ``` ## ๐ŸŽฎ Commands ### scaffold Create new projects from templates: ```bash devboost scaffold <template> [options] Options: -n, --name <name> Project name -p, --path <path> Project path ``` Available templates: - ๐Ÿ”ฅ `react-app`: Modern React application - ๐ŸŒ `node-api`: RESTful Node.js API - โšก `next-app`: Next.js application ### setup Configure development environments: ```bash devboost setup <environment> [options] Options: -f, --force Force setup even if already exists -c, --config <path> Custom config path ``` Available environments: - ๐Ÿ“ฆ `node-env`: Node.js development environment - ๐Ÿ `python-env`: Python development environment - ๐Ÿณ `docker-env`: Docker development environment ### optimize Optimize project performance: ```bash devboost optimize <target> [options] Options: -l, --level <level> Optimization level ``` Available targets: - ๐Ÿ“ฆ `bundle`: Optimize JavaScript bundles - ๐Ÿ–ผ๏ธ `images`: Compress and optimize images - ๐ŸŽจ `css`: Minimize and optimize CSS ### check Run code quality checks: ```bash devboost check <type> [options] Options: -f, --fix Attempt to fix issues ``` Available check types: - ๐Ÿ” `lint`: Run linting checks - ๐Ÿงช `test`: Run test suite - ๐Ÿ”’ `security`: Run security audit ### workflow Manage development workflows: ```bash devboost workflow <action> [options] Options: -e, --env <environment> Target environment ``` Available actions: - ๐Ÿ”„ `ci-setup`: Configure CI/CD pipeline - ๐Ÿš€ `deploy`: Deploy application - ๐Ÿ’พ `backup`: Backup project assets ## โš™๏ธ Configuration DevBoost can be configured using: - Command line options - Configuration file (.devboostrc) - Environment variables Example `.devboostrc`: ```json { "defaultTemplate": "react-app", "optimization": { "level": "aggressive", "targets": ["bundle", "images"] }, "check": { "autoFix": true, "strict": true } } ``` ## ๐Ÿค Contributing We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. ## ๐Ÿ“ License MIT ยฉ [@happyvibess](https://github.com/happyvibess) ## ๐Ÿ’– Support If you find this tool helpful, you can: <a href="https://www.buymeacoffee.com/happyvibess" target="_blank"> <img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;"> </a>