vitesse-dependency-scripts
Version:
Automated toolkit for managing dependencies with pnpm catalogs in Vue/Vite projects
190 lines (139 loc) • 4.1 kB
Markdown
# ⚡ Quick Start Cheat Sheet
One-page reference for all commands.
## 🎯 I Want To...
### ✅ Create a New Project (RECOMMENDED)
```bash
cd dependency-scripts
node create-project-instant.js my-awesome-app
cd ../my-awesome-app
pnpm dev
```
**That's it!** Your project is ready with the latest dependencies! 🚀
### 🔄 Update an Existing Project
```bash
cd dependency-scripts
node auto-update-full.js
cd ..
pnpm dev
```
Updates your current project with latest dependency versions.
## 📋 All Commands
| Command | What It Does | When To Use |
|---------|--------------|-------------|
| `node create-project-instant.js my-app` | ⭐ Create new project with latest deps | Starting fresh (RECOMMENDED) |
| `node create-vitesse-project.js my-app` | Create new project (basic) | Starting fresh (basic output) |
| `node auto-update-full.js` | Update existing project | Updating dependencies |
| `node auto-update-catalog.js` | Update workspace only | Manual control |
| `./install-missing-deps.sh` | Direct install (no catalog) | Quick testing |
## 🚀 Common Workflows
### New E-commerce Project
```bash
cd dependency-scripts
node create-project-instant.js my-shop
cd ../my-shop
pnpm dev
# Open http://localhost:3333
```
### New Admin Dashboard
```bash
cd dependency-scripts
node create-project-instant.js admin-panel
cd ../admin-panel
pnpm dev
```
### Update Existing Project
```bash
cd dependency-scripts
node auto-update-full.js
cd ..
pnpm install
pnpm dev
```
## 🎨 What You Get
### Frontend (20 packages)
- Authorization: @casl/ability, @casl/vue
- Forms: @vuelidate/core, @vuelidate/validators
- UI: element-plus, FontAwesome
- HTTP: axios, vue-axios
- Charts: chart.js, vue-chartjs
- Utils: luxon, vuedraggable, prismjs
- And more...
### Dev Tools (13 packages)
- Icons: @iconify-json/ic, @iconify-json/mdi
- Build: sass, critters, cross-env
- Vite: unplugin-element-plus, vite-plugin-pages
- Types: @types/luxon, @types/node, @types/prismjs
**Total: 33 packages** automatically configured! 📦
## 🔗 Need More Help?
| Guide | What It Covers |
|-------|----------------|
| [WHICH-SCRIPT.md](./WHICH-SCRIPT.md) | Which script should I use? |
| [INSTANT-CREATE-README.md](./INSTANT-CREATE-README.md) | Detailed guide for instant creation |
| [README.md](./README.md) | Full documentation |
## 💡 Tips
### Tip #1: Use Descriptive Names
```bash
✅ node create-project-instant.js customer-portal
✅ node create-project-instant.js invoice-system
❌ node create-project-instant.js test
❌ node create-project-instant.js app
```
### Tip #2: Projects Are Created in Parent Directory
```
hero-market-data-import/
├── dependency-scripts/ ← Run commands here
│ └── create-project-instant.js
└── my-awesome-app/ ← Project created here
├── src/
├── package.json
└── pnpm-workspace.yaml
```
### Tip #3: After Creation
```bash
cd my-awesome-app
code . # Open in VS Code
pnpm dev # Start dev server
```
## 🐛 Troubleshooting
| Problem | Solution |
|---------|----------|
| Directory exists | `rm -rf my-app` or use different name |
| pnpm not found | `npm install -g pnpm` |
| Permission denied | `chmod +x *.js` |
| Slow installation | Normal! Wait for npm to fetch versions |
## ⚡ The Fastest Way
```bash
# One command to rule them all:
cd dependency-scripts && node create-project-instant.js my-app && cd ../my-app && pnpm dev
```
This will:
1. Navigate to scripts folder
2. Create your project
3. Navigate to your project
4. Start dev server
**Your app will be live at http://localhost:3333** 🎉
## 📊 Performance
Typical timings on decent internet:
- Clone template: ~5 seconds
- Fetch versions: ~20-40 seconds
- Install dependencies: ~30-60 seconds
- **Total: ~1-2 minutes** ⚡
## ✨ That's All You Need!
**Most common command:**
```bash
node create-project-instant.js my-awesome-app
```
**Happy coding!** 🚀
Need detailed documentation? Check [README.md](./README.md)