update project config

.gitignore

@@ -3,7 +3,7 @@ src/config/dev.env
 src/config/test.env
 
 /node_modules
-/lib
+/dist
 /coverage
 /.nyc_output
 src/config/*.env

.prettierrc.json

@@ -1 +1,5 @@
-{}
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "singleQuote": true
+}

README.md

@@ -2,6 +2,29 @@
 
 All interactions with DB
 
+## Features
+
+### Linter
+
+The CI Pipeline uses [super-linter](https://github.com/super-linter/super-linter). You can run it locally with the following command:
+
+```bash
+docker run -e RUN_LOCAL=true -e TYPESCRIPT_DEFAULT_STYLE=prettier -e VALIDATE_DOCKERFILE_HADOLINT=false -v $(pwd):/tmp/lint github/super-linter:slim-latest
+```
+
+Note: We have disabled HADOLINT for now as we are getting an error: `qemu: uncaught target signal 11 (Segmentation fault) - core dumped`.
+
+### Tests
+
+The CI Pipeline uses the `test` target from the Dockerfile to run the tests. You can run it locally with the following command:
+
+```bash
+docker compose -f docker-compose.test.yml up --exit-code-from app --build
+```
+
+Note: This will create a /coverage folder where you can review the coverage details.
+
+
 ## Schema for rawinfo
 
 ```

docker-compose.test.yml

@@ -0,0 +1,10 @@
+version: "3.9"
+
+services:
+  app:
+    build:
+      context: .
+      target: test
+      dockerfile: Dockerfile
+    volumes:
+      - ./coverage:/project/coverage