Download the PHP package tavo1987/mini-framework without Composer

Slim Starter Kit

Este un kit de inicio rápido para desarrolar landings o pequeñas aplicaciones usando el framework Slim 3.0, con una estructura muy parecida a Laravel.

nota: Documentación en progreso

Características

• Validaciones
• Emails
• Laravel mix
• Migraciones
• Controladores
• Entidadades o Modelos mediante el uso de Eloquent
• Vistas usando el motor de plantillas de twig
• Templates bases para enviar emails
• url amigables
• Fácil instalación mediante composer
• Módulo Básico de Autenticación
• Middlewares
• Soporte para CSRF
• Sesiones
• Mensajes tipo flash

Herramientas y Tecnologías utilizadas

• Slim 3
• Sass
• Laravel mix
• Vuejs
• VeeValidate
• Foundation 6.4.1
• Tailwincs
• Eloquent ORM
• Twig
• Dotenv
• Swift Maile
• Valitron
• Whoops
• Laravel Collections
• Web font loader
• Phinx
• Laravel migrations

Helpers

* dd()
* dump()
* collect()    
* SendEmail()    
* parseUrl()

Requerimientos

• "php": ">=5.6.4"

Instalación y Configuración

1. Ejecutar el siguiente comando para crear el proyecto:
   • composer create-project tavo1987/mini-framework project-name
2. Crear base de datos para guardar datos del formulario
3. Configurar los datos correctos en el archivo .env
4. Ejecutar el siguiente comando para crear las tablas por defecto users, leads y migrations:
   • vendor/bin/phinx migrate
5. Seleccionar el idioma de los mensajes de valitron mediante la variable VALITRON_LANG este puede tener los siguiente valores en or es por defecto esta en inglés
6. Listo! eso es todo

Compilando assets

Para la compilación de los assets hemos seleccionado laravel mix, el cual nos ayuda a través de su api, configurar y ejecutar rápidamente tareas comúnes que hacemos con nuestros archivos js y css. Cabe mencionar que laravel mix trabaja con webpack por debajo.

Para correr laravel mix seguiremos los siguientes pasos:

1. Editar el archivo webpack.mix.jsy actualizar la opción proxy : 'mini-framework.dev' dentro de la configuración se browsersync para poder los cambios en tiempo real sin recargar la página
2. Instalar las depencias ejecuntado en la consola el comando yarn
3. compilar mediante las siguientes opciones:
   • yarn dev desarrollo
   • yarn watch desarrollo y live preview
   • yarn prod producción

Personalización JS

Por defecto el mini framework viene con las depencias de vuejs, foundation, jquery, vee-validate. Pero estas no son abligatorias ya que fácilmente se puede ignorar las mismas y cargar únicamente lo que se necesite y se adapte a tu flujo de trabajo.

Para realizar los camnbios tenemos que modificar el siguiente archivo resoureces/assets/js/app.js y comentar lo que no necesitemos.

En cuanto a foundation, unicamente se esta cargando los esencial, si necesitas plugins adicionales como acordiones, slider, etc. se los tiene que requerir manualmente en la siguientes sección

Si estas usando Vuejs puedes oraganizar tus componentes dentro de resources/assets/js/components, por defecto hay un componente para cargar el formulario con vuejs Form.vue

Personalización SASS

Todos los archivos sass los podemos encontrar en resources/assets/sass/, de igual manera se puede personalizar foundation a nuestras necesidades, es decir cambiar sus configuraciones por defecto en resources/assets/sass/foundation/_seetings.scss e incluir plugins adicionales, ya que de igual forma que con los js se carga únicamente ciertos componentes de foundation, descomentado los ìnlcudes dentro de resources/assets/sass/foundation/_modules.scss, podemos cargar componentes adicionales. Si no se va a usar foundation podemos eliminarlo comentando o borrando la siguiente sección dentro de nuestro archivo resources/assets/sass/app.scss:

Home

Al abrir el proyecto se podrá observar dos formularios, uno usando vuejs y otro sin vuejs, seleccionar el que se desee y borrar el otro para evitar errores.

Fuentes

Para cargar fuentes personalizadas por favor usar el archivo app.js y edita la siguiente sección

De esta menera mejoramos el tiempo de carga, mas información en web font loader

nota: Recordar actualizar la fuente en el archivo de configuración sass `resources/assets/sass/lib/_settings.scss`

Vulnerabilidades de Seguridad o Errores

Si descubres una vulnerabilidad de seguridad dentro de este mini framework, envía un correo electrónico a [email protected]. Todas las vulnerabilidades de seguridad serán tratadas los más rápido posible. o abre un issue para especificar el error.

Licencia

Mini-framework es un software de código abierto bajo licencia MIT license.