chattigo-webkit 1.19.7

Chattigo Frontend UI Library

Guía para desarrolladores.

Requerimientos

Instalar Gulp client de manera global:

$ npm install gulp-cli -g

Instalación

Directamente desde el directorio raíz.

$ npm install

Levantar modo desarrollo

Solo ejecutar la tarea por defecto de Gulp:

$ gulp

Gulp compilara todos los archivos ubicados en el archivo /app dentro del directorio /dist.

Luego levantara la aplicación compilada en tu browser.

Stylint estará constantemente revisando la calidad del código, siguiendo el styleguide publicado por Sass Guidelines.

Arquitectura de carpetas

├── app
  ├── assets # Fonts, Images, Svg... etc.
  ├── locales # Archivos de Internacionalización 
  ├── scss # ITCSS
    ├── settings  # contain variables, font, colors definitions, etc.
    ├── tools     # mixins and functions
    ├── generic   # reset and/or normalize styles, box-sizing definition, etc.
    ├── elements  # styling for bare HTML elements (like H1, A, etc.).
    ├── objects   # class-based selectors which define undecorated design patterns(OOCSS).
    ├── components # specific UI components.
    ├── trumps    # overrides, helpers, utilities and etc 
                  # that affect single pieces of the DOM.
  ├── views # nunjucks templates
    ├── pages     # used for storing files that will be compiled into HTML.
    ├── templates # used for storing all components and other Nunjucks files 
                  # that will be added to files in the pages folder.
      ├── components # only the html code of the current component
      ├── macros  # templates where you can add variables to it just like
                  # working with a function in JavaScript
      layout.njk # base layout

Generar la documentación

Ejecutar la tarea Gulp:

$ gulp sass:build-docs

Esta generara la documentación en la raíz del repositorio, bajo la carpeta /public/docs/, donde puedes abrir el archivo index.html .

Construido con

Versionamiento

Nosotros usamos SemVer para el versionamiento.