Prepare component

This commit is contained in:
2025-05-30 01:07:33 -06:00
parent 3916c62935
commit cac9a5b121
263 changed files with 14456 additions and 1072 deletions

View File

@ -1,9 +1,77 @@
## 🔐 Acceso al Repositorio Privado
# 🤝 Guía para Contribuidores
Nuestro servidor Git en **Tea** tiene un registro cerrado. Para contribuir:
¡Gracias por tu interés en colaborar con **Koneko ERP**!
Este proyecto busca ofrecer una suite profesional de administración web y ERP orientado al mercado mexicano y LATAM, bajo licencia **Business Source License 1.1** con transición futura a MIT.
1. Abre un **Issue** en [GitHub](https://github.com/koneko-mx/laravel-vuexy-website-admin/issues) indicando tu interés en contribuir.
2. Alternativamente, envía un correo a **contacto@koneko.mx** solicitando acceso.
3. Una vez aprobado, recibirás una invitación para registrarte y clonar el repositorio.
---
Si solo necesitas acceso de lectura, puedes clonar la versión pública en **GitHub**.
## 📌 Requisitos básicos
* Conocimiento de **PHP 8.2+** y **Laravel 11**
* Respeto por las buenas prácticas, código limpio y trabajo en equipo
* Preferentemente, experiencia en:
* Livewire
* Spatie Permissions & Roles
* Laravel Fortify y Sanctum
* Desarrollo modular con Composer
---
## 🌱 Primeros pasos
1. **Forkea** este repositorio y clónalo localmente.
2. Instala las dependencias con Composer:
```bash
composer install
```
3. Copia el archivo `.env.example` a `.env` y ajusta tus credenciales locales:
```bash
cp .env.example .env
php artisan key:generate
```
4. Ejecuta las migraciones y seeders (si aplica):
```bash
php artisan migrate --seed
```
5. Inicia el servidor:
```bash
php artisan serve
```
---
## 📀 Convenciones del Proyecto
Antes de contribuir, asegúrate de leer nuestras
📁 [Convenciones de Componentes](CONVENTIONS.md),
donde definimos estructura de carpetas, estilo de código y otras buenas prácticas clave para mantener la consistencia del ecosistema **Koneko ERP**.
---
## 📝 Código de Conducta
Consulta nuestro [Código de Conducta](CODE_OF_CONDUCT.md) para conocer las expectativas y reglas que garantizan un ambiente colaborativo, profesional y respetuoso.
---
## 🚀 ¡Listo para colaborar!
Una vez que tengas tu entorno configurado:
* Busca issues etiquetados como `good first issue` o `help wanted`
* Lee el archivo [`CONTRIBUTING.md`](CONTRIBUTING.md) del módulo específico si estás trabajando en un subpaquete
* No olvides seguir las convenciones de estilo PSR-12 y usar `php-cs-fixer` si lo tienes disponible
---
Gracias por ser parte de **Koneko ERP** 💙
¡Esperamos tu contribución!