@theoptimalpartner/npm-security-kit 1.0.0

package/QUICK_START.md

@@ -0,0 +1,291 @@
+# Quick Start Guide - NPM Security Kit
+
+## 3 Minutos para Proteger tu Proyecto
+
+---
+
+## Para Proyectos Existentes
+
+### Opción A: Instalación Automática (Más Fácil)
+
+```bash
+# 1. Ir a tu proyecto
+cd /ruta/a/tu-proyecto
+
+# 2. Ejecutar instalación
+bash /home/diego/projects/npm-security-kit/install.sh
+
+# 3. Verificar
+npm run security:check-malicious
+
+# ¡Listo!
+```
+
+### Opción B: Instalación Manual
+
+```bash
+# 1. Copiar archivos
+cp -r /home/diego/projects/npm-security-kit/template/.security tu-proyecto/
+cp -r /home/diego/projects/npm-security-kit/template/scripts tu-proyecto/
+cp -r /home/diego/projects/npm-security-kit/template/.github tu-proyecto/
+
+# 2. Hacer ejecutables
+cd tu-proyecto
+chmod +x scripts/*.sh
+
+# 3. Agregar a package.json (ver abajo)
+```
+
+**Scripts para agregar a package.json**:
+
+```json
+{
+  "scripts": {
+    "security:check": "./scripts/security-check.sh",
+    "security:check-malicious": "./scripts/check-malicious-packages.sh",
+    "security:audit": "npm audit --audit-level=moderate",
+    "security:audit:fix": "npm audit fix",
+    "security:outdated": "npm outdated",
+    "security:licenses": "npm list --json | jq -r '.dependencies | to_entries[] | \"\\(.key): \\(.value.license)\"'",
+    "security:full": "npm run security:audit && npm run security:check"
+  }
+}
+```
+
+---
+
+## Para Proyectos Nuevos
+
+### Desde el Inicio
+
+```bash
+# 1. Crear proyecto
+mkdir mi-nuevo-proyecto
+cd mi-nuevo-proyecto
+npm init -y
+
+# 2. Instalar security kit
+bash /home/diego/projects/npm-security-kit/install.sh
+
+# 3. Instalar dependencias
+npm install
+
+# 4. Verificar
+npm run security:check-malicious
+
+# Ahora tu proyecto nace protegido!
+```
+
+---
+
+## Uso Diario
+
+### Antes de Instalar un Paquete
+
+```bash
+# Ver info del paquete
+npm info nombre-paquete
+
+# Instalar
+npm install nombre-paquete
+
+# Verificar inmediatamente
+npm run security:check-malicious
+```
+
+### Antes de Hacer Deploy
+
+```bash
+npm run security:full
+```
+
+### Si Hay Problemas
+
+```bash
+# Auto-fix
+npm run security:audit:fix
+
+# Verificar de nuevo
+npm run security:full
+```
+
+---
+
+## Comandos Importantes
+
+| Comando | Cuándo Usarlo | Frecuencia |
+|---------|---------------|------------|
+| `npm run security:check-malicious` | Después de instalar paquetes | Cada instalación |
+| `npm run security:audit` | Verificar vulnerabilidades | Diario |
+| `npm run security:full` | Antes de deploy | Pre-deploy |
+| `npm run security:audit:fix` | Cuando hay vulnerabilidades | Según necesidad |
+| `npm run security:outdated` | Ver actualizaciones | Semanal |
+
+---
+
+## Configuración Rápida
+
+### Editar `.security/config.json`
+
+```json
+{
+  "projectName": "mi-proyecto",          // Nombre de tu proyecto
+  "projectType": "react",                 // node, react, nextjs, etc.
+  "strictMode": true                      // Bloquear en CI si hay amenazas
+}
+```
+
+### Tipos de Proyecto
+
+- `node` - Backend Node.js
+- `react` - React app
+- `nextjs` - Next.js
+- `vue` - Vue.js
+- `express` - Express API
+- `serverless` - Lambdas
+- `library` - npm package
+
+---
+
+## GitHub Actions (Automático)
+
+Una vez que hagas push, GitHub Actions ejecutará:
+
+- ✅ Verificación en cada PR
+- ✅ Verificación en cada push
+- ✅ Scan semanal automático (Lunes 9am)
+
+No necesitas hacer nada más!
+
+---
+
+## Dependabot (Automático)
+
+Dependabot abrirá PRs automáticos para:
+
+- ✅ Security patches
+- ✅ Actualizaciones de dependencias
+- ✅ Agrupadas por categoría
+
+Revisa y aprueba semanalmente.
+
+---
+
+## Verificar que Todo Funciona
+
+```bash
+# 1. Verificar blacklist
+ls -la .security/malicious-packages-blacklist.json
+
+# 2. Verificar scripts
+ls -la scripts/*.sh
+./scripts/check-malicious-packages.sh
+
+# 3. Verificar GitHub Actions
+ls -la .github/workflows/security-audit.yml
+
+# 4. Verificar scripts npm
+npm run security:check-malicious
+
+# Si todo sale ✓ estás listo!
+```
+
+---
+
+## Problemas Comunes
+
+### "jq: command not found"
+
+```bash
+# Ubuntu/Debian
+sudo apt-get install jq
+
+# macOS
+brew install jq
+```
+
+### "Permission denied"
+
+```bash
+chmod +x scripts/*.sh
+```
+
+### Scripts npm no funcionan
+
+Asegúrate de que package.json tenga los scripts. Verifica con:
+
+```bash
+cat package.json | grep security
+```
+
+---
+
+## Próximos Pasos
+
+1. ✅ Instalar en proyecto actual
+2. ✅ Ejecutar `npm run security:full`
+3. ✅ Arreglar cualquier problema
+4. ✅ Commit y push
+5. ✅ Verificar GitHub Actions
+6. ✅ Configurar Dependabot
+7. ✅ Repetir en otros proyectos!
+
+---
+
+## ¿Necesitas Ayuda?
+
+- **Documentación completa**: `README.md`
+- **Configuración avanzada**: `.security/config.json`
+- **Issues**: GitHub Issues
+- **Email**: security@tuempresa.com
+
+---
+
+## Ejemplos Reales
+
+### Proyecto Backend (Express)
+
+```bash
+cd mi-api-express
+bash /home/diego/projects/npm-security-kit/install.sh
+npm run security:check-malicious
+# ✓ No malicious packages detected
+```
+
+### Proyecto Frontend (React)
+
+```bash
+cd mi-app-react
+bash /home/diego/projects/npm-security-kit/install.sh
+npm run security:check-malicious
+# ✓ No malicious packages detected
+```
+
+### Librería npm
+
+```bash
+cd mi-libreria
+bash /home/diego/projects/npm-security-kit/install.sh
+npm run security:check-malicious
+# ✓ No malicious packages detected
+```
+
+---
+
+## Checklist de Instalación
+
+- [ ] Ejecutar `install.sh`
+- [ ] Verificar archivos creados (`.security`, `scripts`, `.github`)
+- [ ] Probar `npm run security:check-malicious`
+- [ ] Probar `npm run security:full`
+- [ ] Personalizar `.security/config.json`
+- [ ] Commit archivos a git
+- [ ] Push para activar GitHub Actions
+- [ ] Verificar que Dependabot esté activo
+- [ ] Documentar para el equipo
+
+---
+
+**¡Tu proyecto está protegido!** 🛡️
+
+Repite este proceso en todos tus proyectos para mantener tu código seguro.