Configuración del entorno de desarrollo para este curso

Clase 2 de 27Curso de Backend con Node.js: API REST con Express.js

Resumen

¿Cómo preparar el entorno para un proyecto en Node.js?

Iniciar un nuevo proyecto en Node.js no solo implica la instalación de dependencias y la escritura de código, sino también la configuración adecuada del entorno de desarrollo. Esto asegura que el trabajo sea eficiente, replicable y se adhiera a las mejores prácticas. Exploremos cómo configurar el entorno de nuestro proyecto integrando herramientas esenciales como git, linter y otras prácticas recomendadas.

¿Cómo crear la estructura inicial del proyecto?

  1. Crea una carpeta para el proyecto: Usa el comando mkdir seguido del nombre del proyecto. Por ejemplo:

    mkdir mystore
    cd mystore
    

    Abre esta carpeta en tu editor de preferencia, en este caso utilizaremos Visual Studio Code:

    code .
    
  2. Inicializa el proyecto con npm: Desde la terminal, ejecuta:

    npm init -y
    

    Esto generará un archivo package.json con una configuración básica.

  3. Inicia un repositorio git: Para versionar el proyecto, ejecuta:

    git init
    

¿Qué configuraciones iniciales se deben considerar?

En esta etapa, crearemos archivos de configuración esenciales.

  1. Archivo .gitignore:

    • Evita rastrear archivos innecesarios en el repositorio. Puedes generar un .gitignore para Node.js usando gitignore.io:
      # Agrega Node y sistemas operativos
      node
      windows
      linux
      macos
      
    • Copia la configuración generada en tu archivo .gitignore.
  2. Configuración de EditorConfig:

    • Unifica la configuración del editor para un equipo de desarrollo homogéneo. Requiere la extensión EditorConfig para VSCode.
  3. Archivo .eslintrc.json:

    • Define las reglas del linter para mantener estándares de codificación. Puedes usar estándares como ES6:
      {
        "extends": ["eslint:recommended"],
        "env": {
          "es6": true,
          "node": true
        },
        "parserOptions": {
          "ecmaVersion": 2018
        }
      }
      

¿Cómo configurar los scripts y dependencias de desarrollo?

Para ejecutar scripts y manejar dependencias, debemos modificar el archivo package.json.

  1. Scripts en package.json:

    • Añade scripts para ejecutar el entorno de desarrollo y producción:
      "scripts": {
        "dev": "nodemon index.js",
        "start": "node index.js",
        "lint": "eslint ."
      }
      
  2. Instalación de dependencias de desarrollo:

    • Usa npm para instalar nodemon y herramientas de linteo:
      npm install nodemon eslint eslint-plugin-prettier prettier --save-dev
      

¿Cómo probar el entorno configurado?

Una vez configurado todo el entorno, es momento de realizar pruebas para garantizar que todo funcione correctamente.

  1. Prueba en entorno de desarrollo:

    • Ejecuta:
      npm run dev
      
    • nodemon observará cambios en los archivos .js, recargando automáticamente el servidor.
  2. Prueba en entorno de producción:

    • Usa el comando:
      npm start
      
    • Esto correrá una instancia simple de Node para producción.

Con estos pasos, tu entorno de desarrollo y producción estará listo. Implementar estas prácticas te permitirá mantener una estructura de trabajo ordenada y eficiente. ¡Sigue aprendiendo y mejorando tus habilidades de desarrollo!