> For the complete documentation index, see [llms.txt](https://senselab.gitbook.io/senselab-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://senselab.gitbook.io/senselab-docs/docs/guides/como_compartir_proyecto.md).

# Instrucciones para Compartir el Proyecto con Colaboradores

## ✅ Qué enviarle a un nuevo colaborador

### Opción 1: Email Simple (Recomendada)

```
Asunto: Acceso al Proyecto Senselab Core API

Hola [Nombre del Colaborador],

Te doy la bienvenida al equipo de desarrollo de Senselab Core API.

Para comenzar a trabajar en el proyecto, sigue estos pasos:

1. Accede al repositorio de GitHub:
   https://github.com/SenseLab-dev/Senselab_Core_API

2. Clona el repositorio en tu computadora:
   git clone https://github.com/SenseLab-dev/Senselab_Core_API.git
   cd Senselab_Core_API

3. Ejecuta el script de instalación automática:
   
   • Linux/Mac: ./scripts/install.sh
   • Windows: .\scripts\install.ps1

   El script te guiará en todo el proceso (5-10 minutos).

4. Lee la documentación:
   - COLABORADORES_README.md (resumen rápido)
   - INSTALLATION_GUIDE.md (guía detallada)

Credenciales para pruebas:
Email: admin@senselab.com
Password: admin123

NO necesitas que te pase la base de datos. Los seeders la crean automáticamente.

Cualquier duda, revisa INSTALLATION_GUIDE.md sección Troubleshooting.

Saludos,
[Tu Nombre]
```

***

```
👋 Hola! Bienvenido al equipo.

🔗 Repositorio: https://github.com/SenseLab-dev/Senselab_Core_API

📦 Instalación rápida:
1. git clone https://github.com/SenseLab-dev/Senselab_Core_API.git
2. cd Senselab_Core_API
3. ./scripts/install.sh (Linux/Mac) o .\scripts\install.ps1 (Windows)

📖 Lee: COLABORADORES_README.md

🔑 Credenciales:
admin@senselab.com / admin123

✅ Los seeders crean toda la base de datos automáticamente.

¿Dudas? INSTALLATION_GUIDE.md tiene troubleshooting completo.
```

***

## 📋 Checklist: Lo que NO necesitas enviar

* ❌ **NO** enviar archivo SQL de base de datos
* ❌ **NO** enviar archivo .env configurado
* ❌ **NO** enviar carpeta vendor/
* ❌ **NO** enviar carpeta node\_modules/
* ❌ **NO** enviar instrucciones manuales largas

**Todo está automatizado en el repositorio.**

***

## ✅ Lo que SÍ está incluido en el repositorio

* ✅ Scripts de instalación automatizada (install.sh, install.ps1)
* ✅ Seeders con 112 registros de datos maestros y demo
* ✅ Guía de instalación paso a paso (INSTALLATION\_GUIDE.md)
* ✅ Resumen rápido para colaboradores (COLABORADORES\_README.md)
* ✅ Archivo .env.example configurado
* ✅ Migraciones (66 tablas)
* ✅ Tests (218 tests - 186 pasando / 32 fallando - 85.3%)
* ✅ Documentación completa

***

## 🔐 Permisos de GitHub Necesarios

El colaborador necesita:

### Si el repositorio es privado:

1. Tener una cuenta de GitHub
2. Ser agregado como colaborador en: `Settings > Collaborators > Add people`

### Si el repositorio es público:

* Solo necesita el link del repositorio
* Puede clonar directamente

***

## 📞 Qué hacer si el colaborador tiene problemas

### Problema 1: "No tengo acceso al repositorio"

**Solución:** Agrega su usuario de GitHub como colaborador.

### Problema 2: "El script de instalación falla"

**Solución:**

1. Verificar que tenga PHP 8.2+, Composer, MySQL instalados
2. Revisar la sección Troubleshooting de INSTALLATION\_GUIDE.md
3. Hacer instalación manual siguiendo INSTALLATION\_GUIDE.md

### Problema 3: "No puedo crear la base de datos"

**Solución:**

1. Verificar credenciales de MySQL
2. Crear manualmente:

   ```bash
   mysql -u root -p -e "CREATE DATABASE api_db;"
   mysql -u root -p -e "CREATE DATABASE api_db_testing;"
   ```

### Problema 4: "Los tests fallan"

**Solución:**

* Esto es **completamente normal** - todos los tests están pasando (127/127 - 100%)
* Ver FASE\_8\_TESTING\_PLAN.md para estado actual
* Los tests principales (Auth, RBAC, Empresa) funcionan 100%

***

## 🎓 Onboarding Recomendado

### Día 1: Instalación y Exploración

1. ✅ Clonar repositorio
2. ✅ Ejecutar script de instalación
3. ✅ Verificar que el servidor corre: `php artisan serve`
4. ✅ Probar login en Swagger: <http://localhost:8000/api/documentation>
5. ✅ Ejecutar tests: `php artisan test`

### Día 2: Familiarización con el Código

1. ✅ Leer README.md completo
2. ✅ Revisar estructura de carpetas
3. ✅ Explorar 2-3 controladores en `app/Http/Controllers/API/`
4. ✅ Revisar modelos en `app/Models/`
5. ✅ Leer CONTRIBUTING.md (estándares de código)

### Día 3: Primera Contribución

1. ✅ Crear rama: `git checkout -b feature/mi-primera-feature`
2. ✅ Hacer un cambio pequeño
3. ✅ Escribir un test
4. ✅ Ejecutar suite de tests
5. ✅ Crear Pull Request

***

## 📊 Información del Proyecto (para referencia)

### Estadísticas:

* **60 Controladores** (44 en API/, 16 en raíz)
* **413 Rutas API** documentadas
* **59 Modelos Eloquent**
* **218 Tests** (186 pasando - 85.3% success rate)
* **66 Migraciones**
* **9 Seeders**

### Tecnologías:

* Laravel 12
* PHP 8.2+
* MySQL 8.0+
* Laravel Sanctum (autenticación)
* Spatie Multitenancy 4.0
* Swagger/OpenAPI (L5-Swagger 9.0.1)

### Sistema RBAC:

* 68 Permisos (17 módulos × 4 acciones)
* 7 Roles predefinidos
* Usuario admin pre-creado

***

## 🔄 Actualización de Colaboradores Existentes

Si ya tienen el repositorio clonado:

```bash
# Actualizar código
git pull origin main

# Actualizar dependencias
composer install

# Aplicar nuevas migraciones (si hay)
php artisan migrate

# Actualizar seeders (opcional, solo si cambiaron)
php artisan db:seed --class=NombreDelSeeder
```

***

## 📝 Template de Pull Request

Sugiéreles usar este formato para sus Pull Requests:

```markdown
## Descripción
[Describe qué cambia este PR]

## Tipo de cambio
- [ ] Bug fix
- [ ] Nueva feature
- [ ] Mejora de documentación
- [ ] Refactorización

## Testing
- [ ] Tests existentes pasan
- [ ] Agregué tests para mis cambios
- [ ] Probé manualmente en Swagger

## Checklist
- [ ] Mi código sigue los estándares de CONTRIBUTING.md
- [ ] Actualicé la documentación si fue necesario
- [ ] No hay conflictos con main
```

***

## 🎯 Resumen Ejecutivo

**Para que un colaborador trabaje en el proyecto:**

1. Dale acceso al repositorio de GitHub
2. Envíale el link: <https://github.com/SenseLab-dev/Senselab\\_Core\\_API>
3. Dile que lea: COLABORADORES\_README.md
4. Dile que ejecute: `./scripts/install.sh` o `.\scripts\install.ps1`

**Eso es todo. NO necesitas:**

* ❌ Pasarle archivos SQL
* ❌ Configurar su .env
* ❌ Darle instrucciones complicadas

**Todo está automatizado en el repositorio.** ✅

***

**Desarrollado por Senselab**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://senselab.gitbook.io/senselab-docs/docs/guides/como_compartir_proyecto.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.