Skip to content

dev-flc/react-template

Repository files navigation

R E A C T - T E M P L A T E


Logo

F.L.C

react

Una impresionante plantilla para impulsar sus proyectos!
Explore los documentos »

C O N T E N I D O
  1. Pre-requisitos
  2. Librerias generales del proyecto
  3. Convención de commits
  4. Instalacion de dependencias
  5. Configuración de Eslint y Prettier en VSCode
  6. Ejecución del proyecto en modo desarrollo
  7. Estandar general de desarrollo

Pre-requisitos


Software previo y requerido

Software Versión Documentación
Node.js Node.js
Git Git
VsCode VsCode

volver arriba 🔼


Plugins previos y requeridos para VsCode

Pligins:

NOTA: En caso de utilizar otro editor de código como Subliem text ó Vim, etc. revisar la documentación de los plugin para realizar la instalacion de manera correcta en su editor.

volver arriba 🔼


Librerias generales del proyecto:

Libreria Versión Documentación
React Git
reduxjs/toolkit Redux
Webpack Redux
Babel Redux
Material UI Redux
Sass Redux

volver arriba 🔼


Convención de commits

Es importante tener en cuanta el estandar ya que si no cumples con el no podras realizar los commits.

Documentación

La confirmación contiene los siguientes elementos estructurales para comunicar la intención a los consumidores de su biblioteca:

  • fix: un commit del tipo fix corrige un error en su base de código (esto se correlaciona con PATCH en Semantic Versioning).

  • feat: un commit del tipo feat introduce una nueva característica en el código base (esto se correlaciona con MENOR en el control de versiones semántico).

  • BREAKING CHANGE: un commit que tiene un pie de página BREAKING CHANGE:, o agrega un ! después del tipo/ámbito, introduce un cambio de API importante (que se correlaciona con PRINCIPAL en el control de versiones semántico).

  • BREAKING CHANGE: puede ser parte de commits de cualquier tipo. se permiten tipos distintos de fix: y feat:, por ejemplo @commitlint/config-conventional (basado en la convención Angular) recomienda build:, chore:, ci:, docs:, style:,

  • refactor:, perf:, test: y otros: Se pueden proporcionar pies de página que no sean BREAKING CHANGE: y seguir una convención similar al formato de tráiler de git.

  • La especificación de commits convencionales no exige tipos adicionales y no tienen un efecto implícito en el control de versiones semántico (a menos que incluyan un CAMBIO IMPORTANTE). Se puede proporcionar un alcance al tipo de una confirmación, para proporcionar información contextual adicional y está contenido entre paréntesis, por ejemplo, hazaña (analizador): agregar capacidad para analizar matrices.

Ejemplo: contribution animation

volver arriba 🔼


Instalación de dependencias

Ejecutar el siguiente comando para instalar las dependecias del proyecto.

npm i ó npm install

volver arriba 🔼


Configuración de Eslint y Prettier en VSCode

Archivo .vscode/settings.json de VSCode.

  // configuración de Eslint y Prettier
 "[javascriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  },
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  },
  "[scss]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true
  },
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "javascript.updateImportsOnFileMove.enabled": "always",
  "inlineFold.supportedLanguages": [
    "html",
    "svelte",
    "vue",
    "javascript",
    "typescript",
    "javascriptreact",
    "typescriptreact"
  ],
  "eslint.probe": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "html",
    "vue",
    "markdown"
  ],

NOTA: En caso de utilizar otro editor de código como Subliem text ó Vim, etc. revisar la documentación de ESLint y Prettier

volver arriba 🔼


Ejecución del proyecto en modo desarrollo

Ejecutar el siguiente comando en tu terminal.

SO Windows

npm run dev:win

SO Linux

npm run dev

URL de compilción: localhost

alt text

volver arriba 🔼


Estandar general de desarrollo


Nombre y extenciones de archivos

Nombre del archivo : El nombre será acorde al contenido del archivo o clase del componente, y será en CamelCase, como se muestra en el siguiente ejemplo.

nameFileExample.js

Tipos de extensiones :

.jsx ,   .js ,  .scss

Si el contenido del archivo es JSX, la extensión será .jsx

Si el contenido del archivo es JS la extensión será .js

Si el contenido del archivo son estilos la extensión será .scss

volver arriba 🔼


Nombre de variables

El nombre de la variable será escrito con CamelCase, como se muestra en el siguiente ejemplo :

let nombreVariable = ";

En caso de que la variable sea una constante será escrita con letras mayúsculas separada por guiones bajos, como se muestra en el ejemplo.

const NOMBRE_VARIABLE = null;

volver arriba 🔼


Funciones sin eventos

Las funciones sin eventos serán llamadas acorde a la acción o funcionalidad que realizará la misma y será nombrada con CamelCase, como se muestra en el ejemplo.

nombreFuncion( ) {
  console.log( " Hola Template Webpack 5 " )
}

volver arriba 🔼


Funciones con eventos

Ejemplo de eventos.

  • onClick
  • onChange
  • etc...

Las funciones con eventos propios de los componentes, tendrán al inicio la palabra handler y serán llamadas acorde a la acción o funcionalidad que realizará la misma y será nombrada con CamelCase, como se muestra en el ejemplo.

handlerNombreFuncion( ) {
    console.log( " Hola Suscribe " )
}

volver arriba 🔼


Idemtación

La indentación del cada uno de los archivos será acorde al archivo de configuración .editorconfig, en el cual se encuentran las configuraciones de los archivos de acuerdo a su extensiones.

volver arriba 🔼


Importación y Exportación de componente

Los componentes serán exportados e importados, con el mismo nombre de su clase, ademas sera importado con rutas relativas como se muestra en el ejemplo.

export default NameComponent.

import NameComponent from ./ruta/ruta’

volver arriba 🔼


Store

El store tendrá las siguientes características.

  • Un máximo de tres niveles.
  • Claves escritas CamelCase.
  • No utilizar arreglos.
const INITIAL_STATE = {
	claveA : {
			clave : { ... }
	},
	claveB : {
		claveBUno  : { ... },
		claveBDos  : { ... },
		claveBTres : {
			claveBTresA : { ... },
			claveBtresB : { ... },
			claveBtresC : { ... }
		}
	},
	claveC : { ... },
	claveD : { ... },
	claveE : { ... },
	...
}

volver arriba 🔼

About

template for react, redux, webpack5

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages