Create code challenge and docker-compose file (#1)

Author: alinehaxkar

README.md

@@ -1,2 +1,78 @@
-# app-nodejs-codechallenge
-Code challenge for potential Yaperos :rocket:
+# Yape Code Challenge :rocket:
+
+- [Problem](#problem)
+- [Tech Stack](#tech_stack)
+- [Send us your challenge](#send_us_your_challenge)
+
+# Problem
+
+Every time a financial transaction is created it must be validated by our anti-fraud microservice and then the same service sends a message back to update the transaction status.
+For now, we have only three transaction statuses:
+
+<ol>
+  <li>pending</li>
+  <li>approved</li>
+  <li>rejected</li>  
+</ol>
+
+Every transaction with a value greater than 1000 should be rejected.
+
+```mermaid
+  flowchart LR
+    Transaction -- Save Transaction with pending Status --> transactionDatabase[(Database)]
+    Transaction --Send transaction Created event--> Anti-Fraud
+    Anti-Fraud -- Send transaction Status Approved event--> Transaction
+    Anti-Fraud -- Send transaction Status Rejected event--> Transaction
+    Transaction -- Update transaction Status event--> transactionDatabase[(Database)]
+```
+
+# Tech Stack
+
+<ol>
+  <li>Node. You can use any framework you want (i.e. Nestjs with an ORM like TypeOrm or Prisma) </li>
+  <li>Any database</li>
+  <li>Kafka</li>    
+</ol>
+
+We do provide a `Dockerfile` to help you get started with a dev environment.
+
+You must have two resources:
+
+1. Resource to create a transaction that must containt:
+
+```json
+{
+  "accountExternalIdDebit": "Guid",
+  "accountExternalIdCredit": "Guid",
+  "tranferTypeId": 1,
+  "value": 120
+}
+```
+
+2. Resource to retrieve a transaction
+
+```json
+{
+  "transactionExternalId": "Guid",
+  "transactionType": {
+    "name": ""
+  },
+  "transactionStatus": {
+    "name": ""
+  },
+  "value": 120,
+  "createdAt": "Date"
+}
+```
+
+## Optional
+
+You can use any approach to store transaction data but you should consider that we may deal with high volume scenarios where we have a huge amount of writes and reads for the same data at the same time. How would you tackle this requirement?
+
+You can use Graphql;
+
+# Send us your challenge
+
+When you finish your challenge, after forking a repository, you can open a pull request to our repository. There are no limitations to the implementation, you can follow the programming paradigm, modularization, and style that you feel is the most appropriate solution.
+
+If you have any questions, please let us know.

docker-compose.yml

@@ -0,0 +1,25 @@
+version: "3.7"
+services:
+  postgres:
+    image: postgres:14
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+  zookeeper:
+    image: confluentinc/cp-zookeeper:5.5.3
+    environment:
+      ZOOKEEPER_CLIENT_PORT: 2181
+  kafka:
+    image: confluentinc/cp-enterprise-kafka:5.5.3
+    depends_on: [zookeeper]
+    environment:
+      KAFKA_ZOOKEEPER_CONNECT: "zookeeper:2181"
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:29092,PLAINTEXT_HOST://localhost:9092
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      KAFKA_BROKER_ID: 1
+      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
+      KAFKA_JMX_PORT: 9991
+    ports:
+      - 9092:9092