readme

Author: vr-varad

README.md

@@ -1,11 +1,79 @@
-# Remote Code Execution Engine - CodeBlaster_3000
+# 🚀 CodeBlaster_3000 - Remote Code Execution Engine
 
-## Tech Stack
-- NodeJs
-- Docker
-- Redis - Message Broker
-- BullMQ - Message Queue
+## 🛠️ Tech Stack
+- **Node.js** - Backend API & Worker
+- **Docker** - Containerization
+- **Redis** - Message Broker
+- **BullMQ** - Message Queue for job processing
 
-## Design
+---
+
+## 📜 Architecture
+
+![Design](./images/design.png)
+
+---
+
+## ⚡ Installation
+
+1. **Clone the Repository**
+   ```sh
+   git clone https://github.com/vr-varad/CodeBlaster_3000.git
+   cd CodeBlaster_3000
+   ```
+
+2. **Start Services with Docker Compose**
+   ```sh
+   docker compose up -d
+   ```
+
+   This starts 4 services:
+   - `code_blaster_3000_server` - API server (Port: `3000`)
+   - `code_blaster_3000_worker` - Worker for code execution & result storage
+   - `code_blaster_3000_redis` - Redis as the message broker
+   - `code_blaster_3000_mongo` - MongoDB for storing results
+
+---
+
+## 🚀 Usage
+
+### 1️⃣ Submit Code
+Submit code for execution by making a `POST` request to `/submit`.
+
+**Request Body:**
+```json
+{
+    "code": "print(1)",
+    "language": "python"
+}
+```
+
+**Response:**
+```json
+{
+    "status": "success",
+    "jobId": "123456"
+}
+```
+
+### 2️⃣ Fetch Execution Result
+Retrieve the execution result by making a `GET` request to `/result`.
+
+**Request Body:**
+```json
+{
+    "jobId": "123456"
+}
+```
+
+**Response Example:**
+```json
+{
+    "status": "completed",
+    "output": "1",
+    "jobId": "123456"
+}
+```
+
+---
 
-<img src="./images/design.png" alt="design">

worker/index.js

@@ -15,6 +15,7 @@ const worker = new Worker('code_submission', async (job) => {
                 response
             })
         } catch (error) {
+            console.log(`Job with id ${job.id} giving Error.`)
             await Code_Response.create({
                 jobId: job.id,
                 status: "Error",
@@ -30,10 +31,9 @@ const prePullDockerImages = async () => {
         'node:20'
     ];
 
-    for (const image of images) {
-        console.log(`Pulling image: ${image}`);
-        await execShellCommand(`docker pull ${image}`);
-    }
+    console.log('Pulling Docker Images')
+
+    await Promise.all(images.map((image) => execShellCommand(`docker pull ${image}`)))
 
     console.log('All images pulled successfully!');
 };