Here’s a general overview of how you can use Node js with Magento 2.<\/p>\n\n\n\n
Installing Node js<\/a>: –<\/strong> First, Make sure Node is already installed on your server.<\/p>\n\n\n\n If not, visit this blog to install the node – Installing node using nvm<\/a><\/p>\n\n\n\n Install Dependencies:<\/strong>– Depending on the specific task you want to achieve, you might need to install various Node js packages using npm (Node Package Manager).<\/p>\n\n\n\n Use Example:<\/p>\n\n\n\n After installing the node packages via the npm a file named package.json will be created at the root and it looks like as below –<\/p>\n\n\n\n Create Node js API<\/strong>:- Depending on the specific need create your node js API and place this file in the Magento root directory.<\/p>\n\n\n\n So let us create a basic node API named server.js<\/p>\n\n\n\n Note:-<\/strong> You can set the port dynamic by adding a field in the configuration (system.xml).<\/p>\n\n\n\n Running Your Node js API<\/strong>:- At Magento 2 root run the below command to run the node server.<\/p>\n\n\n\n Note:-<\/strong> You can also run the node server dynamically by creating a button (start and stop) in the Magento 2 configuration. <\/p>\n\n\n\n \u2022 When hit the button to start the node server you can use the below code.<\/p>\n\n\n\n In the above code \u2022 When hit the button to stop the node server you can use the below code.-<\/p>\n\n\n\n In the above code fuser<\/strong> can identify the process using the files or sockets. And fuser can be also used to kill the process. So by using Call Node js API in Magento 2:-<\/strong> Based on your need call node API in Magento 2<\/a> file such as in controllers, plugins, etc. via curl.<\/p>\n\n\n\n As I have created a node API server.js above so I’m calling it in my controller.<\/p>\n\n\n\n That\u2019s all about of Basic usage of node js in Magento 2. Hope this will be helpful.<\/p>\n\n\n\n Thanks for visiting the Webkul<\/a> blog! \ud83d\ude42<\/p>\n\n\n\n Happy Coding!<\/p>\n","protected":false},"excerpt":{"rendered":"npm install<\/code> package-name<\/strong> to install required dependencies at your Magento root. <\/p>\n\n\n\nnpm install express\nnpm install multer<\/pre>\n\n\n\n
{\n "dependencies": {\n "express": "^4.18.2",\n "multer": "^1.4.5-lts.1",\n }\n}<\/pre>\n\n\n\nconst express = require('express');\nconst app = express();\n\napp.get('\/api\/data', (request, response) => {\n response.json({ message: 'Node js with Magento 2' });\n});\n\nconst port = 8080;\napp.listen(port, () => {\n console.log(`Server is running on port ${port}`);\n});<\/pre>\n\n\n\nnode server.js<\/pre>\n\n\n\n
<?php\n\nnamespace Webkul\\NodeWithMagento\\Controller\\Adminhtml;\n\nclass Start extends \\Magento\\Backend\\App\\Action\n{\n \/**\n * Api Url\n *\/\n public const API_URL = "server.js";\n\n \/**\n * @var \\Magento\\Framework\\Controller\\Result\\JsonFactory\n *\/\n protected $resultJsonFactory;\n\n \/**\n * @var \\Magento\\Framework\\App\\Filesystem\\DirectoryList\n *\/\n protected $directoryList;\n\n \/**\n * @var \\Magento\\Framework\\Shell\n *\/\n protected $shell;\n\n \/**\n * @param \\Magento\\Backend\\App\\Action\\Context $context\n * @param \\Magento\\Framework\\Controller\\Result\\JsonFactory $resultJsonFactory\n * @param \\Magento\\Framework\\App\\Filesystem\\DirectoryList $directoryList\n * @param \\Magento\\Framework\\Shell $shell\n *\/\n public function __construct(\n \\Magento\\Backend\\App\\Action\\Context $context,\n \\Magento\\Framework\\Controller\\Result\\JsonFactory $resultJsonFactory,\n \\Magento\\Framework\\App\\Filesystem\\DirectoryList $directoryList,\n \\Magento\\Framework\\Shell $shell\n ) {\n parent::__construct($context);\n $this->resultJsonFactory = $resultJsonFactory;\n $this->directoryList = $directoryList;\n $this->shell = $shell;\n }\n\n \/**\n * Execute method to start server\n *\n * @return \\Magento\\Framework\\Controller\\Result\\Json\n *\/\n public function execute()\n {\n $response = new \\Magento\\Framework\\DataObject();\n $response->setError(false);\n $data = $this->getRequest()->getParams();\n $response->setRoot($this->directoryList->getRoot());\n $rootPath = $this->directoryList->getRoot();\n $node = $this->shell->execute('whereis node');\n $nodePath = explode(' ', $node);\n\n if (!isset($nodePath[1]) || $nodePath[1] == '') {\n $node = $this->shell->execute('whereis nodejs');\n $nodePath = explode(' ', $node);\n }\n if (count($nodePath)) {\n $this->shell->execute($nodePath[1].' '.$rootPath.'\/' . (self::API_URL) . " > \/dev\/null &");\n $response->setMessage(__('Server Started.'));\n $this->messageManager->addSuccess(__('Server has been started.'));\n } else {\n $response->setError(true);\n $response->addMessage(__('NodeJs Api Path not found.'));\n $this->messageManager->setError(__('NodeJs Api Path not found.'));\n }\n\n return $this->resultJsonFactory->create()->setJsonData($response->toJson());\n }\n}<\/pre>\n\n\n\n'whereis node<\/strong>'<\/code> is a shell command that is used to locate the executable file for the Node js runtime in the system.<\/p>\n\n\n\n<?php\n\nnamespace Webkul\\NodeWithMagento\\Controller\\Adminhtml;\n\nclass Stop extends \\Magento\\Backend\\App\\Action\n{\n \/**\n * @var \\Magento\\Framework\\Controller\\Result\\JsonFactory\n *\/\n protected $resultJsonFactory;\n\n \/**\n * @var \\Magento\\Framework\\Shell\n *\/\n protected $shell;\n\n \/**\n * @param \\Magento\\Backend\\App\\Action\\Context $context\n * @param \\Magento\\Framework\\View\\Result\\PageFactory $resultPageFactory\n * @param \\Magento\\Framework\\Controller\\Result\\JsonFactory $resultJsonFactory\n * @param \\Magento\\Framework\\Shell $shell\n *\/\n public function __construct(\n \\Magento\\Backend\\App\\Action\\Context $context,\n \\Magento\\Framework\\View\\Result\\PageFactory $resultPageFactory,\n \\Magento\\Framework\\Controller\\Result\\JsonFactory $resultJsonFactory,\n \\Magento\\Framework\\Shell $shell\n ) {\n parent::__construct($context);\n $this->resultJsonFactory = $resultJsonFactory;\n $this->shell = $shell;\n }\n \n \/**\n * Execute method to stop server\n *\n * @return \\Magento\\Framework\\Controller\\Result\\Json\n *\/\n public function execute()\n {\n $response = new \\Magento\\Framework\\DataObject();\n $response->setError(false);\n $data = $this->getRequest()->getParams();\n $getUserPath = $this->shell->execute('whereis fuser');\n \n if ($getUserPath) {\n $getUserPath = explode(' ', $getUserPath);\n if (isset($getUserPath[1])) {\n $stopServer = $this->shell->execute($getUserPath[1].' -k '.$data['port'].'\/tcp');\n $this->messageManager->addSuccess(__('Server has been stopped.'));\n }\n } else {\n $response->setError(true);\n $response->setMessage(__('Something went wrong.'));\n $this->messageManager->addError(__('Something went wrong.'));\n }\n return $this->resultJsonFactory->create()->setJsonData($response->toJson());\n }\n}<\/pre>\n\n\n\nwhereis fuser<\/code> you can stop the server.<\/p>\n\n\n\n<?php\n\nnamespace Webkul\\NodeWithMagento\\Controller\\Index;\n\nuse Magento\\Framework\\App\\Action\\Action;\nuse Magento\\Framework\\App\\Action\\Context;\n\nclass Index extends Action\n{\n \/**\n * @var \\Magento\\Framework\\Json\\Helper\\Data\n *\/\n protected $jsonHelper;\n\n \/**\n * @var \\Magento\\Framework\\Controller\\Result\\JsonFactory\n *\/\n protected $resultJsonFactory;\n\n \/**\n * @var \\Magento\\Framework\\HTTP\\Client\\Curl\n *\/\n protected $curl;\n\n public function __construct(\n Context $context,\n \\Magento\\Framework\\Json\\Helper\\Data $jsonHelper,\n \\Magento\\Framework\\Controller\\Result\\JsonFactory $resultJsonFactory,\n \\Magento\\Framework\\HTTP\\Client\\Curl $curl\n ) {\n parent::__construct($context);\n $this->jsonHelper = $jsonHelper;\n $this->resultJsonFactory = $resultJsonFactory;\n $this->curl = $curl;\n }\n\n public function execute()\n {\n $apiUrl = 'http:\/\/localhost:3000\/api\/data';\n $this->curl->get($apiUrl);\n $response = $this->curl->getBody();\n $data = $this->jsonHelper->jsonDecode($response, true);\n \n \/\/ Return the API response as JSON\n $result = $this->resultJsonFactory->create();\n return $result->setData($data);\n }\n}<\/pre>\n\n\n\n