Descarga y Configuración

Descarga

Clonando el repositorio

git clone https://github.com/prinick96/Ocrend-Framework.git

Descargando el paquete manualmente

Permisos Necesarios

En caso de estar en LINUX y obtener problemas de persmisos de escritura o lectura, poner en la consola lo siguiente:

sudo chmod -R 777 /ruta/en/donde/esta/el/framework

Configuración

Para empezar la configuración del sitio y que nuestro framework funcione correctamente para empezar a trabajar o para subir a producción, debemos configurar en ./Ocrend/Kernel/Config/Ocrend.ini.yml


site:
  production: false
  name: Mi App
  url: localhost/miapp/
  
router:
  ssl: false
  path: localhost/miapp/        
                

NOTA: Se entiende, que si se está en localhost, y la ruta es http://localhost/carpeta/el-framework/, de acuerdo a eso, se debe configurar el path y la url.

Parámetros en Ocrend.ini.yml

Atributo YAML Función
database/default_driver Driver por defecto que utlizará el framework para establecer conexión con la base de datos
database/drivers/mysql Configuración para conexión con el motor MySQL
  • host host donde estará alojada la base de datos
  • user usuario asociado a la base de datos
  • pass contraseña del usuario
  • name nombre de la base de datos
  • port puerto de conexión, el valor default tomará la configuración de php.ini
  • socket socket de conexión, el valor default tomará la configuración de php.ini
database/drivers/sqlite3 Configuración para conexión con el motor SQlite3
  • file ruta interna en donde se almacenará la base de datos sqlite, es importante que la ruta mantenga ___ROOT___ al principio
mailer Configuración para conexión SMTP para envio de correos electrónicos con Helper\Emails
  • host host de conexión SMTP
  • user correo electrónico de conexión
  • pass contraseña del correo electrónico
  • port puerto de la conexión
  • logo ruta absoluta con http/https de un logotipo para adjuntar en el diseño de los correos electrónicos que se envían
twig Configuración para los templates twig
  • cache activa/desactiva el caché estricto
  • compiled_dir directorio de compilación de las vistas
  • charset juego de caracteres que manejan las vistas
  • strict_variables al establecer en true, twig arrojará errores cada vez que una variable no esté definida en vez de ignorarla
  • autoscape define el autoscape por defecto de html, si se coloca false, el autoescape será deshabilitado
build Configuración del sitio, entre ellos el modo producción, nombre y url
  • production activa/desactiva el modo producción, para más información ver documentación
  • name nombre de la aplicación
  • url url absoluta con https/http de la aplicación donde funciona el framework
  • timezone zona horaria que manejará la aplicación, para más información ver documentación de php
sessions Configuración de las sesiones del sistema
  • lifetime tiempo de vida en segundos de todas las sesiones
  • user_cookie/enable activa/desactiva el uso de cookie encriptada para manejar la sesión de los usuarios
  • user_cookie/key_encrypt contraseña para encriptar/desencriptar la info que se almacena en la cookie de usuario, se recomienda cambiar por cada instalación del framework por una propia de mínimo longitud 20
  • user_cookie/lifetime tiempo en segundos para mantener al usuario conectado, se puede configurar para segundos, minutos, horas, días, semanas o meses. Es importante saber que el tiempo MÍNIMO de la sesión del usuario está definido por el lifetime de las sesiones en general
api Configuración de la API RESTFULL
  • active activa/desactiva la API RESTFULL
  • origin origen aceptado de peticiones, el valor * acepta peticiones de cualquier sitio, es altamente recomendable cambiar el origen por el dominio de producción si la api no servirá información a fuentes externas del servidor
router Configuración del enrutador para las URL's amigables
  • ssl el valor true indica al framework que siempre debe intentar solicitar recursos a través de https:// si encuentra un certificado ssl
  • path ruta de instalación del framework, debe ser exacta, en caso de estar mal configurada el enrutador no servirá y los estilos del sitio no cargarán