Prepare component
This commit is contained in:
157
README.md
157
README.md
@ -1,133 +1,116 @@
|
||||
# 🎨 Laravel Vuexy Website Admin - Vuexy Admin
|
||||
# 🧩 Laravel Vuexy Website Admin
|
||||
|
||||
<p align="center">
|
||||
<a href="https://koneko.mx" target="_blank"> <img src="https://git.koneko.mx/Koneko-ST/koneko-st/raw/branch/main/logo-images/horizontal-05.png" width="400" alt="Koneko Soluciones Tecnológicas Logo"> </a>
|
||||
<a href="https://koneko.mx" target="_blank">
|
||||
<img src="https://git.koneko.mx/Koneko-ST/koneko-st/raw/branch/main/logo-images/horizontal-05.png" width="400" alt="Koneko Soluciones Tecnológicas Logo">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://koneko.mx"><img src="https://img.shields.io/badge/Website-koneko.mx-blue" alt="Sitio Web"></a>
|
||||
<a href="https://packagist.org/packages/koneko/laravel-vuexy-website-admin"><img src="https://img.shields.io/packagist/v/koneko/laravel-vuexy-website-admin" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/koneko/laravel-vuexy-website-admin"><img src="https://img.shields.io/packagist/l/koneko/laravel-vuexy-website-admin" alt="License"></a>
|
||||
<a href="https://git.koneko.mx/koneko"><img src="https://img.shields.io/badge/Git%20Server-Koneko%20Git-orange" alt="Servidor Git"></a>
|
||||
<a href="https://github.com/koneko-mx/laravel-vuexy-website-admin/actions/workflows/tests.yml"><img src="https://github.com/koneko-mx/laravel-vuexy-website-admin/actions/workflows/tests.yml/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://github.com/koneko-mx/laravel-vuexy-website-admin/issues"><img src="https://img.shields.io/github/issues/koneko/laravel-vuexy-website-admin" alt="Issues"></a>
|
||||
<a href="https://koneko.mx"><img src="https://img.shields.io/badge/Sitio%20Web-koneko.mx-blue" alt="Sitio Web"></a>
|
||||
<a href="https://packagist.org/packages/koneko/laravel-vuexy-website-admin"><img src="https://img.shields.io/packagist/v/koneko/laravel-vuexy-website-admin" alt="Versión estable"></a>
|
||||
<a href="https://packagist.org/packages/koneko/laravel-vuexy-website-admin"><img src="https://img.shields.io/packagist/l/koneko/laravel-vuexy-website-admin" alt="Licencia"></a>
|
||||
<a href="https://github.com/koneko-mx/laravel-vuexy-website-admin"><img src="https://img.shields.io/github/issues/koneko-mx/laravel-vuexy-website-admin" alt="Issues"></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## 📌 Descripción
|
||||
|
||||
**Laravel Vuexy Website Admin** es un módulo diseñado para **Laravel Vuexy Admin**, proporcionando [breve descripción de la funcionalidad].
|
||||
**Laravel Vuexy Website Admin** es un módulo del ecosistema **Koneko ERP** desarrollado en Laravel 11, orientado a la administración de contenido web multisitio, multidioma y multitemplate. Forma parte del stack web profesional de Koneko, integrando funcionalidades CMS, SEO, blog, renderización por bloques, cache HTML y plantillas dinámicas.
|
||||
|
||||
### ✨ Características:
|
||||
- 🔹 Integración completa con Vuexy Admin.
|
||||
- 🔹 Funcionalidad clave 1.
|
||||
- 🔹 Funcionalidad clave 2.
|
||||
Está diseñado para integrarse de forma transparente al backend Vuexy Admin y utilizarse con frontends basados en Vite y plantillas como **Porto, Landwind, Notus** y otras.
|
||||
|
||||
---
|
||||
|
||||
## 📦 Instalación
|
||||
### 📦 Características
|
||||
|
||||
Instalar vía **Composer**:
|
||||
* Gestión de múltiples sitios web y dominios
|
||||
* Configuración contextual del sitio (branding, idioma, indexación, manifest.json, etc.)
|
||||
* Editor de contenido por bloques y plantillas Blade
|
||||
* Administración de menús, páginas, SEO y JSON-LD
|
||||
* Blog con artículos, etiquetas, categorías y comentarios
|
||||
* Sistema de caché de contenido completo y por bloque
|
||||
* Integraciones con APIs externas como Google Analytics, Pixel Meta, Tawk.to, etc.
|
||||
|
||||
---
|
||||
|
||||
### 🚀 Instalación rápida
|
||||
|
||||
```bash
|
||||
composer require koneko/laravel-vuexy-website-admin
|
||||
```
|
||||
|
||||
Publicar archivos de configuración y migraciones (si aplica):
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --tag=laravel-vuexy-website-admin-config
|
||||
php artisan migrate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Uso básico
|
||||
|
||||
```php
|
||||
use Koneko\NombreLibreria\Models\Model;
|
||||
|
||||
$model = Model::create([
|
||||
'campo1' => 'Valor',
|
||||
'campo2' => 'Otro valor',
|
||||
]);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Configuración adicional
|
||||
|
||||
Si necesitas personalizar la configuración del módulo, publica el archivo de configuración:
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --tag=laravel-vuexy-website-admin-config
|
||||
```
|
||||
|
||||
Esto generará `config/nombre_libreria.php`, donde puedes modificar valores predeterminados.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Dependencias
|
||||
|
||||
Este paquete requiere las siguientes dependencias:
|
||||
- Laravel 11
|
||||
- `koneko/laravel-vuexy-website-admin`
|
||||
- Dependencias específicas de la librería
|
||||
|
||||
---
|
||||
|
||||
## 📦 Publicación de Assets y Configuraciones
|
||||
|
||||
Para publicar configuraciones y seeders:
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --tag=laravel-vuexy-website-admin-config
|
||||
php artisan vendor:publish --tag=laravel-vuexy-website-admin-seeders
|
||||
php artisan migrate --seed
|
||||
php artisan vendor:publish --tag=vuexy-website-admin-config
|
||||
```
|
||||
|
||||
Para publicar imágenes del tema:
|
||||
> Debes tener instalado `laravel-vuexy-admin` antes de usar este complemento.
|
||||
|
||||
---
|
||||
|
||||
### 📦 Comandos Incluidos
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --tag=laravel-vuexy-website-admin-images
|
||||
php artisan website:seo-helper
|
||||
php artisan website:menu-helper
|
||||
php artisan website:content-helper
|
||||
php artisan website:cache-helper
|
||||
php artisan website:sitemap-generate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Pruebas
|
||||
### ⚙️ Publicación de archivos
|
||||
|
||||
Ejecuta los tests con:
|
||||
Este paquete publica:
|
||||
|
||||
* Rutas, vistas y Livewire components
|
||||
* Archivos de configuración y permisos (RBAC)
|
||||
* Comandos Artisan y generadores de contenido
|
||||
* Extensiones para menú y sistema modular
|
||||
|
||||
```bash
|
||||
php artisan test
|
||||
php artisan vendor:publish --tag=vuexy-website-admin-config
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Repositorio Principal y Sincronización
|
||||
### 🔧 Uso y personalización
|
||||
|
||||
Este repositorio es una **copia sincronizada** del repositorio principal alojado en **[Tea - Koneko Git](https://git.koneko.mx/koneko/laravel-vuexy-website-admin)**.
|
||||
Este módulo permite personalizar su estructura y comportamiento utilizando:
|
||||
|
||||
### 🔄 Sincronización con GitHub
|
||||
- **Repositorio Principal:** [git.koneko.mx](https://git.koneko.mx/koneko/laravel-vuexy-website-admin)
|
||||
- **Repositorio en GitHub:** [github.com/koneko/laravel-vuexy-website-admin](https://github.com/koneko/laravel-vuexy-website-admin)
|
||||
- **Los cambios pueden reflejarse primero en Tea antes de GitHub.**
|
||||
* Middlewares para contexto web y contenido
|
||||
* Configuración multisitio con soporte para templates dinámicos
|
||||
* Sistema de vistas desacoplado compatible con Blade, Vite y renderizado parcial
|
||||
|
||||
### 🤝 Contribuciones
|
||||
Si deseas contribuir:
|
||||
1. Puedes abrir un **Issue** en [GitHub Issues](https://github.com/koneko/laravel-vuexy-website-admin/issues).
|
||||
2. Para Pull Requests, **preferimos contribuciones en Tea**. Contacta a `admin@koneko.mx` para solicitar acceso.
|
||||
|
||||
⚠️ **Nota:** Algunos cambios pueden tardar en reflejarse en GitHub, ya que este repositorio se actualiza automáticamente desde Tea.
|
||||
Puedes extender o sobreescribir cualquier vista, layout o componente Livewire publicado.
|
||||
|
||||
---
|
||||
|
||||
## 🏅 Licencia
|
||||
## 🛠️ Requisitos
|
||||
|
||||
Este paquete es de código abierto bajo la licencia [MIT](LICENSE).
|
||||
* PHP `^8.2`
|
||||
* Laravel `^11.31`
|
||||
* [koneko/laravel-vuexy-admin](https://github.com/koneko-mx/laravel-vuexy-admin) instalado y configurado
|
||||
|
||||
---
|
||||
|
||||
## 📄 Licencia
|
||||
|
||||
Este paquete se distribuye bajo la [Licencia Business Source 1.1 personalizada](LICENSE.es), con transición automática a MIT a los 3 años. Para uso comercial, redistribución o integraciones ampliadas, contacta a:
|
||||
|
||||
📧 [opensource@koneko.mx](mailto:opensource@koneko.mx)
|
||||
|
||||
---
|
||||
|
||||
## 📚 Más Información
|
||||
|
||||
* [Core Vuexy Admin](https://github.com/koneko-mx/laravel-vuexy-admin)
|
||||
* [Documentación en inglés](README.en.md)
|
||||
* [Sitio Oficial Koneko ST](https://koneko.mx)
|
||||
* [Correo de Contacto](mailto:opensource@koneko.mx)
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
Hecho con ❤️ por <a href="https://koneko.mx">Koneko Soluciones Tecnológicas</a>
|
||||
Hecho con ❤️ en México por <a href="https://koneko.mx">Koneko Soluciones Tecnológicas</a>
|
||||
</p>
|
||||
|
Reference in New Issue
Block a user