Configurar un Nuevo Proyecto en Node.js

Los siguientes pasos: inicializar proyecto con pnpm init, configurar el package.json e instalar el framework web, que en nuestro caso será Express, pertenecen al ámbito de un proyecto.

📌Esto significa que deberás repetirlos cada vez que crees un proyecto nuevo desde cero para definir cómo será su entorno.

Paso 1. Inicializar y configurar el proyecto

Para iniciar un proyecto de Node.js, se debe escribir el siguiente comando en la terminal de VS Code:

pnpm init

Esto creará un archivo denominado package.json, el cual es el "cerebro" de tu configuración. Antes de modificarlo, prepararemos el entorno siguiendo estas buenas prácticas:

1.1. Crear un archivo .gitignore

Las dependencias que se guardan en la carpeta node_modules/ pueden ser inmensas (miles de archivos). No tiene sentido subirlas a GitHub. Es suficiente con subir el package.json, ya que cualquier otra persona que se descargue el proyecto solo tendrá que ejecutar pnpm install en la terminal, para recuperar automáticamente todos los paquetes necesarios.

Para crear este archivo de forma automática e indicarle a Git que ignore esa carpeta, ejecuta la siguiente línea en tu terminal:

echo node_modules/ > .gitignore

Nota: Si el comando te genera algún error, puedes crear el archivo .gitignore a mano en VS Code y escribir dentro node_modules/

1.2. Configurar el uso de módulos (ES Modules) en el package.json

Abre el archivo package.json que se creó al principio y añade la propiedad "type": "module" dentro del objeto principal del mismo (en caso de que no se encuentre). Esto te permitirá usar la sintaxis moderna de JavaScript (import/export) en lugar del antiguo require.

1.3. Configurar el script de desarrollo (arranque automático)

Busca la sección de "scripts" dentro del package.json y añade un script de desarrollo. Esta herramienta reiniciará el servidor automáticamente cada vez que guardes un cambio. Dependiendo de tu versión de Node.js, elige una de estas dos opciones:

  • Opción A (Recomendada - Node.js 18.11 o superior): Usamos la bandera nativa --watch sin instalar dependencias externas:
  • Opción B (Para versiones antiguas de Node.js): Si estás usando una versión anterior, primero instala Nodemon en la terminal con pnpm add -D nodemon y luego añade el script:
Paso 2. Instalar Express

En el desarrollo moderno usamos frameworks que nos permitan crear servidores y rutas de forma limpia. En nuestro caso usaremos Express (el estándar actual).

Instala Express con el siguiente comando desde la terminal:

pnpm add express

En estos momentos, tu package.json debería lucir así:

Paso 3. Crear el archivo index.js

Para probar que todo está correcto, crea un archivo llamado index.js y pega el siguiente código en él:

Guarda el archivo (Ctrl S).

Paso 4. Probar la configuración e instalación

Para probar que todo esté correcto, escribe el siguiente código desde la terminal de Windows:

pnpm dev

Al escribir pnpm dev, le estás diciendo a tu gestor de paquetes: "Busca en mi archivo package.json el script llamado "dev" y ejecuta la instrucción larga que tiene guardada dentro".

  • Si elegiste la Opción A, pnpm dev ejecutará por detrás: node --watch index.js
  • Si elegiste la Opción B, pnpm dev ejecutará por detrás: nodemon index.js

Para detener el servidor se presionan las teclas Ctrl C desde la terminal.