Optimus

Works with:

Optimus es un framework ligero y optimizado para el desarrollo rápido de aplicaciones web. Está diseñado para mejorar el rendimiento de las aplicaciones al cargar elementos rápidamente y manejar errores de forma efectiva en el lado del cliente. Sin animo de lucro

El equipo actualmente esta estabilizando ficheros y creando las configuraciones para que los usuarios al usar Optimus puedan usar el server local. Estará estable para mediados de Septiembre.

Sitio web: https://optimusjs.netlify.app/

Características

• Optimización de rendimiento: Carga rápida de elementos en la interfaz de usuario.
• Manejo de errores integrado: Muestra mensajes de error claros en la interfaz en caso de fallos.
• Facilidad de uso: Sintaxis simple para la definición de estado y renderización de componentes.

Instalación

Puedes instalar Optimus directamente desde npm o incluirlo como un script en tu proyecto.

npm install @drxcodev/optimus

Uso Básico

Para empezar a usar Optimus en tu proyecto, sigue estos pasos simples:

1. Inicializa el framework en tu archivo JavaScript principal:

document.addEventListener("DOMContentLoaded", () => {
  async function loadTemplate(state) {
    // Simula un retraso para el ejemplo de carga diferida
    await new Promise(resolve => setTimeout(resolve, 1000));
    return (
      '<div>' +
        '<h1>Hello Optimus</h1>' +
        //'<h1> + state.message + </h1>'
        /* Utilizalo para imprimir el mensaje del state global */
      '</div>'
    );
  }

  window.app = new OptimizedFramework({
    el: '#app',
    state: {
      message: 'Hola, Mundo optimizado!'
    },
    template: loadTemplate
  });
});

2. Crea un contenedor en tu HTML donde se renderizará la aplicación:

<div id="app"></div>

3. Personaliza la función loadTemplate y el estado inicial según las necesidades de tu aplicación.

Ejemplos

Cambio de mensaje

Este ejemplo muestra cómo cambiar dinámicamente el mensaje en la aplicación usando setState:

<button onclick="window.app.setState({ message: '¡Nuevo mensaje!' })">Cambiar mensaje</button>

Warning

It is currently disabled.

Manejo de Errores

Optimus maneja automáticamente los errores y los muestra en la interfaz de usuario.

Wiki State

Esta sección es donde estará toda la documentacion de cada state que vayamos creando

      message: 'Hola, Mundo optimizado!', //  Mensaje como variable = 'Tu mensaje'
      title: 'Hello, Optimus',            //  Titulo de la ventana = 'Tu titulo'
      year: currentYear,                  //  Activa esta funcion si quieres que aparezca el año = currentYear
      darkMode: true,                     //  Cambia el tema = [true](Tema oscuro) | [false](Tema claro)
      clickMessage: 'Click Me'            //  Mensaje del boton antes de hacer un evento = 'Click Me'

Opciones

• Estado de la ubicación local por continente: Puedes editar en que continente puedes lanzar el servidor para ver como de diferentes maneras puedes ver el rendimiento de la web
  • Ves a test/propieties/user.yaml
  • En user.yaml

    local: automatic # !: EU, USA, LATAM, ASIA, EUASIA, AFRICA, OCE

Warning

Actualmente esta deshabilitado porque sigue en desarrollo, pronto estará

• Compatibilidad con Pug Si quieres utilizar una sintaxis más legible de HTML puedes utilizar PUG, es un framework de HTML que ayuda a tener un codigo más legible y tener menos fallos a la hora de usarlo.
  • Pasos para utilizarlo:
    • Primero ves a tu carpeta donde esta tu HTML(Debe de estar vacio).
    • Crea un archivo llamado tuarchivo.pug
    • Escribe tu codigo (es un codigo muy similar al html)
    • Forma automatica(sin codigo)
      • Instala como forma global PUG:

        $ npm install -g pug

      • Pasa a forma HTML:

        $ pug tuarchivo.pug

    • Forma manual(codigo)
      • Instala pug en package.json

        $ npm install pug

      • Crea tu archivo llamado tuarchivo.pug
      • Instala fs en package.json

        $ npm install fs

      • Agrega tu codigo de pug: Ejemplo:

        html
        h1 Hola Mundo

      • Crea un archivo .js(app.js)
      • Añade este codigo(codigo generado con coffee.js)

        // Generated by CoffeeScript 2.7.0
        (function() {
          // Requerir los módulos necesarios
          var fs, html, pug;
        
          pug = require('pug');
        
          fs = require('fs');
        
          // Compilar el archivo Pug a HTML
          html = pug.renderFile('Tu archivo PUG');
        
          // Escribir el resultado en un archivo HTML
          fs.writeFileSync('Tu archivo HTML', html);
        
          console.log('Archivo HTML generado con éxito.');
        
        }).call(this);

        • Depura con Node.js node app.js

Warning

Puede no ser compatible con algunos navegadores.

API

Optimus cuenta con su propia API la que tiene muchas opciones, puedes contribuir añadiendo la tuya añadiendo su función

Las actuales API's

–> updateTitle : window.app.updateTitle(\'Optimus with you\') // Cambia el título de la pagina

Paquetes

Hemos incorporado paquetes creados por el equipo y por la comunidad a Optimus. Para importar los paquetes es muy fácil solamente debes de instalar el installer.exe. Una vez descargado lo que debes de hacer es iniciarlo y posteriormente elegir una opción de todas las que hay. Automaticamente se instalará una carpeta con los archivos del paquete anteriormente escojido.

Partners

Esta sección aparecen las empresas, comunidades y personas que nos ayudan a que el proyecto poco a poco salga adelante

Ignora los siguientes apartados

Ignora los siguientes apartados, algunos están en prueba y no son relevantes

| lab/ |

Contribución

¡Contribuciones son bienvenidas! Si quieres contribuir a Optimus, sigue estos pasos:

1. Haz un fork del repositorio y clónalo en tu máquina local.
2. Crea una nueva rama (git checkout -b feature/nueva-funcionalidad).
3. Realiza tus cambios y haz commit (git commit -am 'Añade nueva funcionalidad').
4. Sube tus cambios al repositorio (git push origin feature/nueva-funcionalidad).
5. Abre un pull request en GitHub.

Nuestra tabla de contribucion:

Ley organica de la protección de datos: https://www.boe.es/eli/es/lo/2018/12/05/3/con