PHPackages rguezque/skeleton-project-katya-router - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. rguezque/skeleton-project-katya-router ActiveProject rguezque/skeleton-project-katya-router ====================================== Skeleton para proyectos, utilizando katya-router v1.0.0(5mo ago)01MITPHP Since Nov 14Pushed 1mo agoCompare [ Source](https://github.com/rguezque/skeleton-project-katya-router)[ Packagist](https://packagist.org/packages/rguezque/skeleton-project-katya-router)[ RSS](/packages/rguezque-skeleton-project-katya-router/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (5)Versions (3)Used By (0) Skeleton Project for `katya-router` =================================== [](#skeleton-project-for-katya-router) *Skeleton para proyectos, utilizando katya-router* Tip Después de clonar este repo elimina la carpeta `.git`; así podrás gestionar desde cero el control de versiones de tu proyecto. --- **Tabla de contenidos** - [Instalar dependencias](#instalar-dependencias) - [Composer (PHP)](#composer-(php)) - [Bootstrap](#bootstrap) - [Font Awesome](#font-awesome) - [NPM (JS)](#npm-(js)) - [Configurar Axios](#configurar-axios) - [Configurar Alpine](#configurar-alpine) - [Servidor de prueba](#servidor-de-prueba) - [Producción](#producci%C3%B3n) - [i18n](#i18n) - [Ambiente de desarrollo](#ambiente-de-desarrollo) - [Helpers](#helpers) --- Instalar dependencias --------------------- [](#instalar-dependencias) ### Composer (PHP) [](#composer-php) Ejecuta en la terminal: ``` composer install ``` Se instalarán las dependencias de producción/desarrollo y se copiaran automáticamente los archivos necesarios dentro de `public/`. Si por algún motivo no se copian los archivos, hazlo de forma manual como se describe a continuación. Important Para el caso de `Axios` y `Alpine`, estos se intentarán descargar desde su respectivo CDN en `cdn.jsdelivr.net`. Si llegará a fallar, intenta descargarlos desde el CDN en `unpkg.com` ejecutando en la terminal `composer run download-from-unpkg-assets`. Si todo lo anterior falla, puedes intentar descargarlos usando el gestor de paquetes NPM de NodeJS; se incluye un archivo de configuración `package.json` (Ver la sección [NPM (JS)](#npm-(js)) para más información sobre configuración para el proyecto. #### Bootstrap [](#bootstrap) Copia los archivos `.css` y `.js` según el siguiente mapeo: - `vendor/twbs/bootstrap/dist/css/bootstrap.min.css`: Se copia al directorio `public/static/css/bootstrap/` - `vendor/twbs/bootstrap/dist/js/bootstrap.bundle.min.js`: Se copia al directorio `public/static/js/bootstrap/` También puede llamarse desde un CDN en `app.css`: ``` /* filepath: /public/static/css/app.css */ @import url("https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css"); ``` Y en `app.module.js`: ``` // filepath: /public/static/js/app.module.js import 'https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js' ``` Note - Para usar los estilos de Bootstrap: Solo necesitas `bootstrap.min.css`. - Para usar las funcionalidades interactivas de Bootstrap: Necesitas `bootstrap.bundle.min.js` (además de `bootstrap.min.css`) que ya incluye la dependencia `Popper.js`. #### Font Awesome [](#font-awesome) Copia el archivo `.css` y el directorio `webfonts/` según el siguiente mapeo: - `vendor/components/font-awesome/css/all.min.css`: Se copia al directorio `public/static/css/fontawesome/css/` - `vendor/components/font-awesome/webfonts`: Se copia al directorio `public/static/css/fontawesome/` También puede llamarse desde un CDN en `app.module.js`: ``` import 'https://kit.fontawesome.com/7b35949868.js' ``` ### NPM (JS) [](#npm-js) Ejecuta en la terminal: ``` npm install ``` Se instalarán las dependencias de producción/desarrollo y se copiaran automáticamente los archivos necesarios dentro de `public/`. Si por algún motivo no se copian los archivos, hazlo de forma manual como se describe a continuación. Note Después de copiar las depéndencias a `public/` puedes eliminar el directorio `node_modules/` #### Configurar Axios [](#configurar-axios) Copia el archivo `axios.min.js` según el siguiente mapeo: - `node_modules/axios/dist/axios.min.js`: Se copia al directorio `public/static/js/axios/` Alternativamente puede configurarse para llamarse desde un CDN en `app.module.js`: ``` import 'https://unpkg.com/axios@1.6.7/dist/axios.min.js'; ``` Para este proyecto se aplican las siguientes configuraciones de axios en `public/static/js/app.module.js`: ``` // Crea una instancia de Axios y configura la URL base para las peticiones a la API const api = axios.create({ baseURL: getCookie('API_URL'), timeout: 10000, // Tiempo máximo de espera para una petición }); // Por default se enviará el header 'X-Requested-With' en cada petición api.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest'; // Desactiva el cache, lo que significa que las peticiones no se almacenarán en caché. // Garantiza que cada petición sea fresca desde el server. api.defaults.headers.get = { 'Cache-Control': 'no-cache', 'Pragma': 'no-cache', 'Expires': '0' }; // y el Content-Type para peticiones POST api.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'; ``` #### Configurar Alpine [](#configurar-alpine) Copia el archivo `cdn.min.js` y renómbralo según el siguiente mapeo: - `node_modules/alpinejs/dist/cdn.min.js`: Se copia al directorio `public/static/js/alpine/alpine.min.js` Alternativamente puede configurarse para llamarse desde un CDN en `app.module.js`: ``` import 'https://cdn.jsdelivr.net/npm/alpinejs@3.14.8/dist/cdn.min.js'; ``` Servidor de prueba ------------------ [](#servidor-de-prueba) Ejecuta en la terminal: ``` composer run dev ``` Luego abre el navegador en `http://localhost:8000`. Para terminar el proceso pulsa CTRL+c. Important Si al volver a ajecutar el servidor de prueba arroja error de que el puerto sigue ocupado, ejecuta: `sudo lsof -i :8000` y luego `sudo kill -9 ` Producción ---------- [](#producción) Ejecuta en la terminal: ``` composer install --no-dev ``` i18n ---- [](#i18n) Configura la internacionalización en el archivo `bootstrap/app.php` y coloca los archivos JSON con las traducciones en el directorio `i18n/`. Los archivos de traducción deben nombrase con los dos primeros caracteres del idioma. Ej. `es`, `en`, etc. El método `i18n::configure` detectará automáticamente el idioma del navegador, sin embargo se cargará por default el idioma español `es` en caso de que por algún motivo no sea detectado. Puedes cambiar el idioma default enviandolo como primer argumento. ``` use Project\Core\i18n; // En este caso se cargara el idioma inglés en caso de que no se pueda detectar el idioma nativo del navegador web i18n::configure(lang: 'en', path: __DIR__.'/i18n'); ``` A partir de aquí se puede acceder a la función `i18n()` en las vistas; de esta forma se accede a las claves con las traducción correspondiente. ``` { "title": "Mi aplicación", "description": "Bienvenido al sistema." } ``` En un archivo de vista se carga la traducción así: ``` DOCTYPE html> ``` Important Los archivos de idioma que se espera que se detecten automáticamente deben existir obligatoriamente. Para cualquier otro idioma que no se espera ofrecer soporte, el archivo de idioma default también debe existir. Ambiente de desarrollo ---------------------- [](#ambiente-de-desarrollo) Para configurar el ambiente de desarrollo y manejo de errores utiliza la clase estática `Environment`. El método `Environment::register` buscará automáticamente la variable de entorno `APP_ENV`, si no existe asignará el entorno `development`; aunque también puedes definir directamente el entorno de desarrollo. ``` Environment::register(); // O explicitamente Environment::register('production') Environment::setLogPath(dirname(__DIR__) . '/logs'); ``` Para los bloques `try-catch` utiliza `Environment::handleException` en el `catch`, de esta forma los logs se guardarán con información detallada, pero el mensaje mostrado al usuario cambiará dependiendo del entorno de desarrollo; en `development` mostrará todo el *trace string* mientras que en `production` solo mostrará un error `500 Internal Error Server`. Consulta el [`README.md`](https://github.com/rguezque/katya-router/blob/master/README.md#environment-management) del router para más información. Helpers ------- [](#helpers) Los *helpers* son funciones cargadas automáticamente al inicio y que facilitan ciertas tareas específicas: - `url(string $path)`: Genera la URL completa para un recurso dada su ruta relativa dentro del dominio. - `i18n(string $key)`: Obtiene una traducción por su clave. Si no existe, se devuelve el string de la clave. Esta función es un atajo del método `i18n::get` para recuperar traducciones previamente cargadas por la clase `Pressmark\App\Config\i18n`. - `env(string $key, mixed $default = null, ?int $cast_to = null)`: Devuelve variables de entorno previamente cargadas en `$_ENV`, si el valor no existe devuelve el valor *default* especificado; opcionalmente se puede enviar un número entero como *flag* para especificar a que tipo de dato castear el valor a devolver. Las *flags* posibles son `CAST_INT`, `CAST_STR`, `CAST_FLOAT`, `CAST_ARRAY`, `CAST_BOOL`, `CAST_OBJECT`. Es un atajo de la función `env()` del router. - `resources(array $styles = [], array $scripts = [])`: Imprime las etiquetas `` y `` para los recursos especificados relativos a `/public/static`, o el directorio que se haya definido como 'estático'. Si los scripts tienen la extensión `.module.js`, se les añade el atributo `type="module"`. - `metadata(array $metadata = [])`: Genera multiples etiquetas `` HTML a partir de metadatos globales (previamente cargados con `App::setMetadata`) y adicionales. - `metatag(array $attributes = [])`: Genera una etiqueta `` HTML. - `pipe(...$fns)`: Devuelve el resultado de ejecutar una secuencia de funciones en *pipeline* sobre un valor específico. Ej. `pipe('strtolower', 'ucwords', 'trim')(' jOHn dOE ')` devuelve 'John Doe'. - `sanitize_input(string|array $data)`: Sanitiza recursivamente un valor o un arreglo de valores. Aplica el filtro `FILTER_SANITIZE_FULL_SPECIAL_CHARS` para codificar caracteres especiales HTML y prevenir ataques XSS. - `generate_csrf_token()`: Genera un token CSRF, lo guarda en la sesión y lo devuelve. Si ya existe un token en la sesión, lo devuelve. - `csrf_field()`: Genera el campo input hidden con el token CSRF para el formulario. Ej. ``. - `validate_csrf_token(Parameters $request)`: Valida el token enviado en la solicitud (`$_POST` o `$_GET`) contra el token guardado en la sesión activa. También están disponibles los *helpers* definidos en la libreria de `katya-router`. Consulta el [`README.md`](https://github.com/rguezque/katya-router/blob/master/README.md#helpers) del router. ### Health Score 33 — LowBetter than 75% of packages Maintenance82 Actively maintained with recent releases Popularity1 Limited adoption so far Community6 Small or concentrated contributor base Maturity36 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 169d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/cff6726075cd59f732d23d14c33f7d11c3402fb75c554bcfb0abd16c4f559415?d=identicon)[rguezque](/maintainers/rguezque) --- Top Contributors [![rguezque](https://avatars.githubusercontent.com/u/23480766?v=4)](https://github.com/rguezque "rguezque (20 commits)") ### Embed Badge ![Health badge](/badges/rguezque-skeleton-project-katya-router/health.svg) ``` [![Health](https://phpackages.com/badges/rguezque-skeleton-project-katya-router/health.svg)](https://phpackages.com/packages/rguezque-skeleton-project-katya-router) ``` ### Alternatives [aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 255.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)