Pasos para inicializar un proyecto en nodeJS.

BASES QUE CUALQUIER PROYECTO NECESITA

Conjunto de folders y archivos para organizar nuestro código Versionamiento con git. Puede incluir dependencias. Todo proyecto lleva PRUEBAS DE UNIDAD. (No negociable)

Cuida del orden para que el orden cuide de ti by @Carlo Gilmar

Intalar la ultima versión de nodeJS.

Escoger tu editor de texto favorito.

En mi caso uso Visual Code.

Usar y conocer tu SO en su línea de comandos.

En mi caso windows 10.

  1. Crear un proyecto nuevo.

  2. Inicializar el proyecto agregando package.json ▶️ npm init (Recuerda siempre VERSIONAR tus apps)

image

image

image

  1. Una vez inicializado nuestro proyecto, ya podemos comenzar a instalar las dependencias que usaremos.
  • npm install –save-dev jest

Verifica que depués de esto se haya creado un directorio llamado node_modules este contiene todos los scripts de js de las dependencias.

RECUERDA NUNCA VERSIONARLO : para evitar que se versione creamos en la RAÍZ del proyecto un archivo llamado .gitignore con el nombre de lo que no quieras versionar, en este caso: **/node_modules , con esto vamos a decirle a git que excluya este directorio de los commits que realicemos.

Mira todos estos cambios pendientes antes de crear el archivo .gitignore

image

Creando .gitignore

image

Fijate como después de instalar Jest, el corazón de nuestra app lo registra.

image

  1. Crea la estructura de tu proyecto, las carpetas donde iran tus archivos y tus pruebas unitarias etcetc.

Por ejemplo en LauchX usamos dos directorios principales(app y test), en app van todas nuestras clases y se duplica todo en test para que cada fucnionalidad tenga su prueba unitaria.

Regla de oro: Por cada funcionalidad primero se hace una prueba unitaria.

  1. Creación de prueba unitaria, la idea es hacerla fallar y pensar en todos los escenarios, y despues hacer que pase.

Partiendo de ahi, crear la funcionalidad.

  1. Crea un archivo en la raíz de tu proyecto que se llame index.js. Este será el archivo principal de este proyecto e inicializalo en tu package.json

image

  1. Ve a tu archivo package.json, y modifica la línea que inicia con “test” por:

node ./node_modules/jest/bin/jest.js" (puede variar dependiendo del sistema operativo)

Con esto , podremos activar el comando npm test y correr las pruebas

El script del package.json se usa para declarar la palabra con la que vamos a inicializar alguna dependencia instalada

  1. Instala ESLint en tu proyecto ▶️ npm install eslint –save-dev

8.1. Ejecuta el comando para generar la configuración del linter ▶️ npm init @eslint/config esto te generará un archivo llamado .eslintrc.js , ahi se agregan las reglas que podemos decirle al Linter que revise en nuestros archivos, nos ayudan a detectar mejoras de escritura.

image

8.2. Automatiza los comandos de eslint en tu package.json.

image

##CONFIGURACIONES EXTRA

Instalar servidor express ▶️ npm install express –save

Instalar Prisma ▶️ npm install prisma –save-dev

Instalar bot de telegram npm ▶️ install node-telegram-bot-api –save

Dependencia que nos ayudará a tener configuración externalizada - npm install dotenv –save Crea un archivo .env en la raíz de tu proyecto con contenido que necesites.

DEPENDENCIAS

  • Jest - es una librería abierta para pruebas en JavaScript desarrollada por Facebook. Su eslogan es “Pruebas de JavaScript deliciosas”.

Documentación Jest

  • Dependencia express - Express es una de las dependencias más populares y usadas en NodeJs porque nos permite implementar una infraestructura web flexible y rápida, ya sea para un desarrollo web clásico o implementar una RESTFul Api. Referencia

  • esLint - ESLint es la herramienta predominante para la tarea de “limpiar” código javascript tanto en el servidor (node.js) como en el navegador.

Documentación

Refrencia de mas sobre lint

PRUEBAS DE UNIDAD

TDD

GLOSARIO

  • NPM (Node Package Manager) es un gestor de paquetes de js que nos permite obtener cualquier librería, nos permitirá agregar y usar dependencias de forma simple.

  • npm init - activará la inicialización de tu proyecto, se generará un archivo package.json y se guardará en el directorio actual.

  • archivo package.json - el corazón de tu proyecto ❤️, maneja todas tus dependencias y referencias.

  • VERSIONAR tus apps - usar git como un diario de commits de loq ue vas haciendo, te recomiendo este contenido que lo explica muy cool

Curso Git by Carlo Gilmar

  • Depencia JS - bibliotecas de js que nos facilitan la vida

  • node_modules este contiene todos los scripts de js de las dependencias, RECUERDA NUNCA VERSIONARLO

  • npm run linter para que el linter se ejecute y te diga todas las inconsistencias de escritura.

  • npm run linter-fix corrige.