Crea una cuenta o inicia sesión

¡Continúa aprendiendo sin ningún costo! Únete y comienza a potenciar tu carrera

Primeros pasos en NPM

5/15
Recursos

Desde una terminal o línea de comandos, crea un directorio con el nombre de tu proyecto. Después, como buena práctica, inicia un repositorio local de Git dentro de la carpeta creada.

El símbolo $ representa la línea de entrada para los comandos en la terminal.

```bash

Terminal

$ mkdir npm $ cd npm $ git init Initialized empty Git repository in /pruebas/.git/ ```

Una vez creado el espacio correspondiente al proyecto de JavaScript. Deberás tener un archivo de configuración llamado package.json.

Cómo estructurar un archivo de configuración package.json

El archivo package.json es un archivo de configuración que contiene la información más importante de tu proyecto como: datos específicos, dependencias, dependencias de desarrollo y archivos de ejecución.

Este archivo, como su extensión lo indica, está estructurado en formato JSON (JavaScript Object Notation) que sirve para una mejor lectura e interpretación para los usuarios y las máquinas.

Datos específicos del archivo package.json

Los datos específicos ayudan a identificar el proyecto y actúan como una base para que los usuarios y los contribuidores obtengan información sobre el proyecto.

El archivo package.json estaría estructurado inicialmente por las siguientes propiedades:

  • "name": Indica el nombre del proyecto.
  • "version": Indica la versión del proyecto.
  • "description": Indica una breve descripción del proyecto.
  • "main": Indica el archivo principal del proyecto.
  • "scripts": Indica los comandos a ejecutar del proyecto (no te preocupes por el comando test por ahora).
  • "keywords": Indica las palabras clave del proyecto.
  • "author": Indica el nombre y dirección de correo electrónico del propietario del proyecto.
  • "license": Indica la licencia del proyecto.

El archivo package.json estaría estructurado de la siguiente manera:

```json // archivo package.json

{ "name": "npm", "version": "1.0.0", "description": "Constuir un paquete para node", "main": "src/index.js", "scripts": { "test": "echo \"Error no test specified\" && exit 1" }, "keywords": [ "javascript", "node", "package" ], "author": "TuNombre tucorreo@gmail.com", "license": "MIT" } ```

Cómo utilizar el comando npm init

Aunque puedes crear el archivo de configuración manualmente, NPM te ayuda a crearlo rápidamente mediante el comando npm init. Este comando te permite ingresar los datos específicos del proyecto y genera el archivo package.json en tu directorio.

```bash $ npm init This utility will walk you through creating a package.json file. It only covers the most common items, and tries to guess sensible defaults.

See npm help init for definitive documentation on these fields and exactly what they do.

Use npm install <pkg> afterwards to install a package and save it as a dependency in the package.json file.

Press ^C at any time to quit. package name: (npm) ```

Puedes ingresar tus propios datos, o utilizar la recomendación de NPM (lo que está entre paréntesis) y solamente dar enter. Al final, te preguntará si la configuración del package.json es correcta para generar el archivo.

```bash version: (1.0.0) description: Constuir un paquete para node entry point: (index.js) src/index.js test command: npm test git repository: keywords: javascript, node, package author: TuNombre tucorreo@gmail.com license: (MIT) About to write to /npm/package.json:

{ "name": "npm", "version": "1.0.0", "description": "Constuir un paquete para node", "main": "src/index.js", "scripts": { "test": "echo \"Error no test specified\" && exit 1" }, "keywords": [ "javascript", "node", "package" ], "author": "TuNombre tucorreo@gmail.com", "license": "MIT" }

Is this OK? (yes) ```

Cómo utilizar el comando npm init --yes

El comando npm init --yes o npm init -y te ayudará a crear un archivo package.json de manera rápida con una configuración por defecto, sin la necesidad de ingresar los datos.

Para establecer esta configuración por defecto, necesitarás utilizar el comando npm config set init-<atributo>. Te comparto algunas de las configuraciones por defecto más comunes:

bash $ npm config set init-author-name "Tu Nombre" $ npm config set init-author-email "[email protected]" $ npm config set init-author-url "https://tuWeb.com" $ npm config set init-license "MIT" $ npm config set init-version "0.0.1"

De esta manera ya estás listo para gestionar dependencias de tu proyecto con NPM.

Contribución creada por Andrés Guano (Platzi Contributor).

Aportes 15

Preguntas 4

Ordenar por:

¿Quieres ver más aportes, preguntas y respuestas de la comunidad?

o inicia sesión.

Hola [email protected] 😃
Comparto mis apuntes

  • “name”: “npm-init” —> Podemos ponerle un nombre sin embargo toma por defecto el de la carpeta.

  • “version”: “1.0.0” —> Podemos cambiar segun el caso, dependiendo un cambio mayor o uno menor

  • “description”:"" —> Podemos hacer una breve descripcion del proyecto.

  • “entry point”: “(index.js)” —> Punto de entrada del proyecto.

  • “test command”: —> Podemos incluir los comandos para validar nuestro codigo.

  • “git repository”: —> Podemos incluir el repositorio para mantenerlo en la nube

  • “keywords”: [“javascript”, “angular”, “node”] —> Que va a utilizar nuestro proyecto.

  • “author”: "Alexa Pulido<pulidoaleXXXXXXX> —> Persona que crea el proyecto

  • “license”: “MIT” —> Licencias, la mas utilizada es MIT, permite distribuir nuestro codigo.

en mi opinión este curso debería estar mas arriba en la ruta, ya que en cursos pasados vi cosas de node y npm que apenas en este curso estoy despejando dudas, pero excelente curso!

Si usan Windows vayan a la fija e instalen y trabajen todo desde WSL. En el curso de Prework para Windows explican como Instalarlo y configurarlo

Les dejo un buen recurso donde pueden leer más de la config y como pueden setear configuraciones default para cualquier proyecto futuro:

https://codeburst.io/setting-global-npm-defaults-for-quick-starting-new-projects-ed06ed22edb3

Yo uso git bash en el caso window, se me hace mas comodo que el wsl

Yo uso windows y para seguir los comandos de la clase uso git bash, que es como una terminal de linux pero en windows, pero cada quien que haga lo que mejor le venga

Para la gente que usa windows les invito a instalar
oh my posh o como indicó Oscar instalar WSL

💡 Hola! las dependencias son importantes ya que con estas podemos reutilizar codigo de otros desarroladores de una forma rapida y sencilla, para instalar dependecias podemos hacerlo a travez de npm y yarn

¿Como Instalar una Dependecia?

Para Instalar una dependencia con npm iniciamos con la siguiente forma.

npm install <nombre de la dependecia>

Dependecias de Desarrollo

Al agregar --save-dev despues del nombre de la dependendecia estamos especificando que solo vamos a utillizar la dependecia en el entorno de desarrollo. Asi mismo podemos utilizar -D despues del nombre de la dependecia

npm install <nombre de la dependecia> --save-dev

#Tambien podemos utilizar

npm install <nombre de la dependecia> -D

Dependencias de Producción

Al agregar —-save despues del nombre de la dependecia estamos especificando que es una dependecia que utilizara en producción

npm install <nombre de la dependecia> --save

Dependencias Globales

Al agregar —g antes del nombre de la dependecia, estamos especificando que la dependecia que estamos instalando esta en el scope global

npm install -g <nombre de la dependecia>
npm init -y es El comando para la inicializacion de Las confoguraciones por defecto

Para los que usan Windows como yo les recomiendo usar WSL

se puede desde git yo lo hago sin problema desde ahi

Les dejo este video de Sacha Lifszyc en un Platzi Live sobre las diferentes licencias que existen para el software:

Ver video

Pasos de la clase:

  • Crear espacio de trabajo -> mkdir npm -> cd npm
  • Crear -> mkdir npm-init ->cd npmn-init -> git init (clear limpiar terminal)
  • npm init -> crear base del proyecto con datos del mismo
  • Tambien se puede utilizar -> npm init -y para generar el archivo package.json

Apunte en Notion