vtasks-automate-cli 0.6.4 → 0.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# vtasks-automate-cli
|
|
2
|
+
|
|
3
|
+
Automatizá el flujo de trabajo de tus tareas en **vTasks** con un solo comando.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 ¿Qué hace este CLI?
|
|
8
|
+
|
|
9
|
+
`vtasks-automate-cli` es una herramienta diseñada para integrarse fácilmente en tu proyecto con frontend (Next.js o create-react-app) y backend (Node.js), y así automatizar el movimiento de tarjetas en **vTasks** mientras trabajás con ramas vinculadas a tareas.
|
|
10
|
+
|
|
11
|
+
Con solo ejecutar el comando:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx vtasks-automate-cli
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
la herramienta hará lo siguiente:
|
|
18
|
+
|
|
19
|
+
1. 📦 **Instalará automáticamente la dependencia de automatización** en el frontend y el backend del proyecto.
|
|
20
|
+
2. 🔧 **Modificarán los scripts de ejecución**:
|
|
21
|
+
- En el backend: actualiza `npm start`
|
|
22
|
+
- En el frontend (Next.js): actualiza `npm run dev` (o si el proyecto aun utiliza create-react-app actaualiza `npm start`)
|
|
23
|
+
3. 🛠️ Agrega un githook para detectar los cambios de ramas y notificar que cambiaste la tarea en la que estas trabajando
|
|
24
|
+
4. ⚙️ Al quedar configurado, **las tarjetas de vTasks se moverán automáticamente** a medida que que estés trabajando en las distintas ramas.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 📦 Instalación
|
|
29
|
+
|
|
30
|
+
No requiere instalación global. Solo ejecutá:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx vtasks-automate-cli
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Este comando detectará automáticamente tus carpetas de frontend y backend, instalará lo necesario, y actualizará los scripts.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 🧠 ¿Cómo funciona?
|
|
41
|
+
|
|
42
|
+
El paquete se integra en el ciclo de desarrollo de tu equipo. Cuando ejecutás los scripts habituales (`npm start` o `npm run dev`), se activa el sistema de automatización, que:
|
|
43
|
+
|
|
44
|
+
- Detecta la rama en la que estás trabajando.
|
|
45
|
+
- Detecta el usuario y el nombre del proyecto desde la configuración de git.
|
|
46
|
+
- Se comunica con la API de **vTasks**.
|
|
47
|
+
- Mueve la tarjeta correspondiente al estado "En Progreso".
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## 🛠️ Requisitos
|
|
52
|
+
|
|
53
|
+
- Un proyecto con:
|
|
54
|
+
- Backend con Node.js y script `npm start` o
|
|
55
|
+
- Backend de React y script `npm start` o
|
|
56
|
+
- Frontend con Next.js y script `npm run dev`
|
|
57
|
+
- Tener ramas creadas a través de **vTasks**, siguiendo el formato sugerido por la plataforma.
|