@create-lft-app/cli 1.0.4 → 1.0.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 +120 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# @create-lft-app/cli
|
|
2
|
+
|
|
3
|
+
CLI para crear proyectos LFT con Next.js, GitHub, Supabase y Jira integrados.
|
|
4
|
+
|
|
5
|
+
## Instalacion
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @create-lft-app/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Configuracion
|
|
12
|
+
|
|
13
|
+
Antes de usar el CLI, configura las credenciales en un archivo `.env` en el directorio del paquete:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# ===========================================
|
|
17
|
+
# GITHUB
|
|
18
|
+
# ===========================================
|
|
19
|
+
# Token: https://github.com/settings/tokens/new
|
|
20
|
+
# Permisos necesarios: repo, read:org, admin:org (para crear repos en org)
|
|
21
|
+
LFT_GITHUB_TOKEN=ghp_xxxxxxxxxxxx
|
|
22
|
+
LFT_GITHUB_USERNAME=tu-usuario
|
|
23
|
+
LFT_GITHUB_ORG=tu-organizacion # Opcional, deja vacio para cuenta personal
|
|
24
|
+
|
|
25
|
+
# ===========================================
|
|
26
|
+
# SUPABASE
|
|
27
|
+
# ===========================================
|
|
28
|
+
# Token: https://supabase.com/dashboard/account/tokens
|
|
29
|
+
LFT_SUPABASE_TOKEN=sbp_xxxxxxxxxxxx
|
|
30
|
+
# Org ID: https://supabase.com/dashboard/org/[ORG_ID]/settings
|
|
31
|
+
LFT_SUPABASE_ORG_ID=xxxxxxxxxxxx
|
|
32
|
+
LFT_SUPABASE_REGION=us-east-1 # Opcional
|
|
33
|
+
|
|
34
|
+
# ===========================================
|
|
35
|
+
# JIRA
|
|
36
|
+
# ===========================================
|
|
37
|
+
# Token: https://id.atlassian.com/manage-profile/security/api-tokens
|
|
38
|
+
LFT_JIRA_TOKEN=ATATT3xxxxxxxxxxx
|
|
39
|
+
LFT_JIRA_EMAIL=tu-email@ejemplo.com
|
|
40
|
+
LFT_JIRA_DOMAIN=tu-dominio.atlassian.net
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Uso
|
|
44
|
+
|
|
45
|
+
### Crear un proyecto nuevo
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
create-lft-app mi-proyecto
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Crear proyecto con confirmacion automatica
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
create-lft-app mi-proyecto -y
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Opciones disponibles
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
create-lft-app [nombre-proyecto] [opciones]
|
|
61
|
+
|
|
62
|
+
Opciones:
|
|
63
|
+
-V, --version Muestra la version
|
|
64
|
+
--skip-github No crear repositorio en GitHub
|
|
65
|
+
--skip-supabase No crear proyecto en Supabase
|
|
66
|
+
--skip-jira No crear proyecto en Jira
|
|
67
|
+
--skip-git No inicializar git ni hacer push
|
|
68
|
+
-y, --yes Aceptar todas las confirmaciones
|
|
69
|
+
-h, --help Muestra ayuda
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Ejemplos
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Crear proyecto completo
|
|
76
|
+
create-lft-app mi-app
|
|
77
|
+
|
|
78
|
+
# Crear solo con GitHub y Next.js (sin Supabase ni Jira)
|
|
79
|
+
create-lft-app mi-app --skip-supabase --skip-jira
|
|
80
|
+
|
|
81
|
+
# Crear proyecto local sin servicios externos
|
|
82
|
+
create-lft-app mi-app --skip-github --skip-supabase --skip-jira --skip-git
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Que crea el CLI
|
|
86
|
+
|
|
87
|
+
1. **GitHub**: Repositorio privado en tu cuenta u organizacion
|
|
88
|
+
2. **Supabase**: Proyecto con base de datos PostgreSQL
|
|
89
|
+
3. **Jira**: Proyecto de software con template Scrum
|
|
90
|
+
4. **Next.js**: Aplicacion con:
|
|
91
|
+
- TypeScript
|
|
92
|
+
- Tailwind CSS
|
|
93
|
+
- App Router
|
|
94
|
+
- ESLint
|
|
95
|
+
- Turbopack
|
|
96
|
+
|
|
97
|
+
## Recursos existentes
|
|
98
|
+
|
|
99
|
+
Si alguno de los recursos ya existe (repo, proyecto Supabase, proyecto Jira, o directorio), el CLI lo detecta y continua sin error, mostrando un checkmark con "(ya existe)".
|
|
100
|
+
|
|
101
|
+
## Desarrollo local
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Clonar repositorio
|
|
105
|
+
git clone https://github.com/Test-Boiler/create-lft-app.git
|
|
106
|
+
cd create-lft-app
|
|
107
|
+
|
|
108
|
+
# Instalar dependencias
|
|
109
|
+
npm install
|
|
110
|
+
|
|
111
|
+
# Build
|
|
112
|
+
npm run build
|
|
113
|
+
|
|
114
|
+
# Ejecutar localmente
|
|
115
|
+
node dist/bin/cli.js mi-proyecto
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Licencia
|
|
119
|
+
|
|
120
|
+
MIT
|