testing

/

README.md

@@ -1,70 +1,11 @@
-# respJS
-[![Mocha](https://img.shields.io/badge/-mocha-%238D6748?style=for-the-badge&logo=mocha&logoColor=white)](https://github.com/0oM4R/respJS/actions/workflows/test.yaml)
-[![Tests](https://github.com/0oM4R/respJS/actions/workflows/test.yaml/badge.svg)](https://github.com/0oM4R/respJS/actions/workflows/test.yaml)
-[![Coverage Status](https://coveralls.io/repos/github/0oM4R/respJS/badge.svg?branch=development_codeCoverage)](https://coveralls.io/github/0oM4R/respJS?branch=development_codeCoverage)
+# `respJS`
 
-## Introduction
-
-This code is a simple implementation of a TCP server that handles Redis-like commands. It listens on port 6379 and uses the net module in Node.js to create a TCP server. When a client connects, it logs the connection details and handles incoming data.
-
-requirements:
-
-This code is based on some node.js modules so make sure you have [Node.js](https://nodejs.org/en/download) installed
-
-## Installation
-
-You can clone the repository and run the server with the following command:
-
-- `git clone https://github.com/0oM4R/respJS.git`
-- `yarn` to install some small dependencies
-- `yarn start` to start the server
-
-## Testing
-
-You can run the tests using `npm test`
+> TODO: description
 
 ## Usage
 
-### Using redis-cli
-
-open the redis-cli on your terminal by typing `redis-cli`
-
-```bash
-
-127.0.0.1:6379> myPing
-PONG
-127.0.0.1:6379> testurl https://google.com
-true
-(0.51s)
-
 ```
+const respjs = require('respJS');
 
-### Using netcat
-
-```bash
-echo -e "*1\r\n+myPing\r\n" | netcat localhost 6379
-+PONG
+// TODO: DEMONSTRATE API
 ```
-
-```bash
-echo -e "*2\r\n+testurl\r\n\$18\r\nhttps://google.com\r\n" | netcat localhost 6379
-+true
-
-```
-
-## Description
-
-The code consists of several classes and helper functions:
-
-The serializeData class provides methods for serializing different types of data into Redis protocol format. It includes methods for handling simple strings, errors, integers, bulk strings, and arrays.
-
-The deserializeData class provides methods for deserializing data received from clients. It can parse and convert Redis protocol-formatted data back into JavaScript objects. It handles different Redis data types such as simple strings, integers, errors, bulk strings, and arrays.
-
-The controller class extends the serializeData class and acts as a command router. It receives deserialized commands from clients and performs specific actions based on the command type. It includes a commandsParser method for parsing and routing commands. Currently, it supports the `myPing` and `testurl` commands.
-
-The main part of the code creates a TCP server using net.createServer(). It listens for incoming connections and handles data received from clients. When data is received, it deserializes it using the deserializeData class, passes it to the controller class for processing, and sends back a serialized response to the client.
-
-You can start the server by running the script, and it will listen on port 6379. Clients can connect to the server and send Redis-like commands, which will be processed and responded to accordingly.
-
-Note: This code assumes the presence of additional dependencies and modules, such as fetch for the "testurl" command. Make sure to install and include any required dependencies before running the code.
-

__tests__/respJS.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const respjs = require('..');
+const assert = require('assert').strict;
+
+assert.strictEqual(respjs(), 'Hello from respjs');
+console.info('respjs tests passed');

lib/respJS.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = respjs;
+
+function respjs() {
+  return 'Hello from respjs';
+}

package.json

@@ -1,10 +1,13 @@
 {
   "name": "respjs-core1",
-  "version": "1.0.0-rc-1",
+  "version": "2.0.0-rc",
   "description": "javascrip RESP server with custom commands",
   "main": "./src/server.js",
-  "repository": "[email protected]:0oM4R/respJS.git",
-  "author": "<[email protected]>",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/0oM4R/respJS.git"
+  },
+  "author": " <[email protected]>",
   "license": "MIT",
   "private": false,
   "scripts": {
@@ -17,5 +20,16 @@
   },
   "dependencies": {
     "nyc": "^15.1.0"
-  }
+  },
+  "bugs": {
+    "url": "https://github.com/0oM4R/respJS/issues"
+  },
+  "homepage": "https://github.com/0oM4R/respJS#readme",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ]
 }