implementing incompass sdk in readme

This commit is contained in:
daniel muniz
2024-06-13 09:45:23 -03:00
parent 94bcf578c4
commit 37cef6e464

View File

@@ -1,14 +1,41 @@
# netstar-categorizer
# UDP Server
# UDP Server - netstar-categorizer
This project is a UDP server built with Node.js that processes incoming messages and returns categorized results.
This project is a UDP server built with Node.js that processes incoming messages and returns categorized NetStar results in Zvelo pattern.
## Prerequisites
- Node.js (v12.x or higher recommended)
- npm (v6.x or higher recommended)
- NetStar inCompass SDK
## Setup
## InCompass SDK Setup
1. The inCompass SDK requires Boost C++ Libraries. To install the libraries, run:
```
apt-get install libboost-all-dev
```
2. To install the inCompass SDK, run:
```
dpkg -i gcf1-global_{SDK Version}_deb{Debian Version}-amd64.deb
```
3. To daemonize the service, run:
```
cp -p /usr/local/gcf1/sbin/gcf1 /etc/init.d/
insserv gcf1
```
4. Or, depending on the Debian version, run:
```
systemctl enable gcf1
```
## UDP Server Setup
1. Clone the repository:
@@ -37,3 +64,4 @@ To start the UDP server, use the following command:
```
npm start
```
This will run the server and bind it to the port specified in your .env file.