@happyvibess/dev-boost
Version:
๐ Supercharge your development workflow with smart automation
174 lines (133 loc) โข 4.44 kB
Markdown
# DevBoost ๐
<div align="center">
[](https://www.npmjs.com/package/@happyvibess/dev-boost)
[](https://opensource.org/licenses/MIT)
[](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>