Let’s start to get our hands dirty and start a Node project.

To start a Node project, is necessary to create a package.json file, which acts a manifest containing the project’s metadata and dependencies of the project. This file is essential part of any Node.js project.

Note: This file is not strictly necessary but is highly recommended and essential for most practical purposes. Below are some points that why we should use it:

• Without package.json: You can still create and run simple JavaScript files using Node.js, but you won’t have a way to manage dependencies or project metadata. For example, you can write a server.js file and run it directly with Node.js.
• With package.json: This file allows you:
  • Manage dependencies with tools like npm or yarn.
  • Define metadata like the project name, version, and author.
  • Add scripts for automation (e.g., start, test).
  • Make sure your project is organized and easier to share or collaborate on.

In this case we will try to use it always as is it possible.

Creating a package.json

To create a package.json file and initialize a Node project in your current working directory, use the next command in the terminal.

$ npm init

By running npm init, you will be prompted to enter the necessary details for your project. This includes information like: the project name, version, description, entry point file, author, license, and more. You can give these details by answering the prompts in the terminal. After you give the details the prompt will ask you if the data is correct to create the package.json file.

$ 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: (node) my-node-project
version: (1.0.0) 
description: A sample Node.js project
entry point: (index.js) 
test command: 
git repository: 
keywords: 
author: Arancesare
license: (ISC) MIT
About to write to /node_project/package.json:

{
  "name": "my-node-project",
  "version": "1.0.0",
  "description": "A sample Node.js project",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Programming Squirrel",
  "license": "MIT"
}


Is this OK? (yes) 

After providing the required information, the npm init will generate a package.json file in your current directory where the command was executed. If you open the file, you will see the details you entered neatly formatted in JSON.

{
  "name": "my-node-project",
  "version": "1.0.0",
  "description": "A sample of node project",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Programming Squirrel",
  "license": "MIT"
}

The package.json file is like the “instruction manual” for your Node.js project. It helps you organize and manage important parts of your project, like:

• Dependencies: The tools and libraries your project needs to work.
• Scripts: Commands you can run easily, like starting the project or running tests.
• Project information: Details like the project’s name, version, and author.

When starting a new Node.js project, the first step is to create a package.json file using the npm init command. This sets up a solid foundation to organize and manage your project effectively.

Happy Learning!!!

Your Turn

Have you ever started a Node.js project without a package.json file? What was your experience? Share your thoughts and any tips you have for new developers in the comments below!