clean: remove production details and unnecessary comments from env files

- Clean up .env.example and .env files
- Remove production-specific configurations and examples
- Remove unnecessary comments and explanations
- Keep only essential development environment variables
- Focus on contributor-friendly setup

This aligns with the open-source project focus on contributors

Author: vikashkrdeveloper

.env.example

@@ -1,13 +1,10 @@
 # SafeExec - Secure Code Execution Platform
-# Copy this file to .env and configure for your environment
+# Copy this file to .env and configure for your local development
 
 # ================================
 # ENVIRONMENT CONFIGURATION
 # ================================
-# Environment: development, test, production
 ENV=development
-
-# Node.js Environment
 NODE_ENV=development
 
 # ================================
@@ -25,7 +22,7 @@ MONGO_USERNAME=admin
 MONGO_PASSWORD=devpassword
 MONGO_DB=safeexec_dev
 MONGO_PORT=27017
-MONGO_URI=mongodb://localhost:27017/safeexec_dev
+MONGODB_URI=mongodb://admin:devpassword@localhost:27017/safeexec_dev?authSource=admin
 
 # ================================
 # REDIS CONFIGURATION
@@ -37,7 +34,6 @@ REDIS_URI=redis://localhost:6379
 # ================================
 # SECURITY CONFIGURATION
 # ================================
-# JWT Configuration (CHANGE IN PRODUCTION!)
 JWT_SECRET=dev-jwt-secret-change-in-production
 JWT_EXPIRES_IN=24h
 
@@ -70,58 +66,6 @@ SWAGGER_UI_ENABLED=true
 # DOCKER CONFIGURATION
 # ================================
 DOCKER_HOST=/var/run/docker.sock
-BUILD_TARGET=development
-SUBNET=172.20.0.0/16
-
-# Nginx Configuration
 NGINX_HTTP_PORT=80
 NGINX_HTTPS_PORT=443
-
-# Health Check Configuration
-HEALTH_CHECK_INTERVAL=30s
-HEALTH_CHECK_TIMEOUT=10s
-
-# Development Volume Mounts (for hot reload)
-DEV_VOLUME_MOUNT=.
-DEV_NODE_MODULES_MOUNT=/tmp/node_modules
-
-# ================================
-# ENVIRONMENT-SPECIFIC EXAMPLES
-# ================================
-
-# Development Environment
-# ENV=development
-# LOG_LEVEL=debug
-# SWAGGER_UI_ENABLED=true
-# BUILD_TARGET=development
-# HEALTH_CHECK_INTERVAL=10s
-# API_PORT=5000
-# MONGO_PORT=27017
-# REDIS_PORT=6379
-
-# Test Environment  
-# ENV=test
-# LOG_LEVEL=error
-# SWAGGER_UI_ENABLED=false
-# BUILD_TARGET=test
-# HEALTH_CHECK_INTERVAL=5s
-# API_PORT=5001
-# MONGO_PORT=27018
-# REDIS_PORT=6380
-# JWT_EXPIRES_IN=1h
-
-# Production Environment
-# ENV=production
-# LOG_LEVEL=warn
-# SWAGGER_UI_ENABLED=false
-# BUILD_TARGET=production
-# HEALTH_CHECK_INTERVAL=30s
-# API_PORT=5000
-# MONGO_PORT=27017
-# REDIS_PORT=6379
-# REDIS_PASSWORD=secure_redis_password_change_me
-# MONGO_PASSWORD=secure_mongo_password_change_me
-# JWT_SECRET=super-secure-jwt-secret-change-me
-# ALLOWED_ORIGINS=https://yourdomain.com,https://www.yourdomain.com
-# DEV_VOLUME_MOUNT=/dev/null
-# DEV_NODE_MODULES_MOUNT=/dev/null
+WORKER_REPLICAS=1

README.md

@@ -59,13 +59,26 @@ nano .env  # or use your preferred editor
 **Sample .env for local development:**
 
 ```env
+# Environment
+ENV=development
 NODE_ENV=development
 PORT=5000
-MONGO_URI=mongodb://localhost:27017/rce_dev
-REDIS_HOST=localhost
-REDIS_PORT=6379
+
+# MongoDB (use localhost for local development & MongoDB Compass)
+MONGO_USERNAME=admin
+MONGO_PASSWORD=devpassword
+MONGO_DB=safeexec_dev
+MONGODB_URI=mongodb://admin:devpassword@localhost:27017/safeexec_dev?authSource=admin
+
+# Redis (use localhost for local development & Redis clients)
+REDIS_URI=redis://localhost:6379
+
+# Security
 JWT_SECRET=your-super-secret-jwt-key-for-development
 JWT_EXPIRES_IN=24h
+
+# CORS
+ALLOWED_ORIGINS=http://localhost:3000,http://localhost:3001
 ```
 
 ### 3. Quick Setup (Recommended for Contributors)

docker-compose.yml

@@ -15,7 +15,7 @@ services:
     environment:
       MONGO_INITDB_ROOT_USERNAME: ${MONGO_USERNAME:-admin}
       MONGO_INITDB_ROOT_PASSWORD: ${MONGO_PASSWORD:-devpassword}
-      MONGO_INITDB_DATABASE: ${MONGO_DB:-rce_system}
+      MONGO_INITDB_DATABASE: ${MONGO_DB:-safeexec_dev}
     ports:
       # Auto-allocate ports if default is busy
       - '${MONGO_PORT:-27017}:27017'
@@ -69,15 +69,24 @@ services:
       - '${DEBUG_PORT:-9229}:9229'
     environment:
       NODE_ENV: ${ENV:-development}
-      PORT: 5000
-      MONGODB_URI: mongodb://${MONGO_USERNAME:-admin}:${MONGO_PASSWORD:-devpassword}@mongodb:27017/${MONGO_DB:-rce_system}?authSource=admin
+      PORT: ${PORT:-5000}
+      MONGO_USERNAME: ${MONGO_USERNAME:-admin}
+      MONGO_PASSWORD: ${MONGO_PASSWORD:-devpassword}
+      MONGO_DB: ${MONGO_DB:-safeexec_dev}
+      MONGODB_URI: mongodb://${MONGO_USERNAME:-admin}:${MONGO_PASSWORD:-devpassword}@mongodb:27017/${MONGO_DB:-safeexec_dev}?authSource=admin
       REDIS_URI: redis://${REDIS_PASSWORD:+:${REDIS_PASSWORD}@}redis:6379
       JWT_SECRET: ${JWT_SECRET:-dev-jwt-secret-change-in-production}
       JWT_EXPIRES_IN: ${JWT_EXPIRES_IN:-24h}
       DOCKER_HOST: /var/run/docker.sock
       LOG_LEVEL: ${LOG_LEVEL:-info}
       ALLOWED_ORIGINS: ${ALLOWED_ORIGINS:-http://localhost:3000}
       SWAGGER_UI_ENABLED: ${SWAGGER_UI_ENABLED:-true}
+      MAX_SUBMISSIONS_PER_MINUTE: ${MAX_SUBMISSIONS_PER_MINUTE:-10}
+      MAX_SUBMISSIONS_PER_HOUR: ${MAX_SUBMISSIONS_PER_HOUR:-100}
+      MAX_SUBMISSIONS_PER_DAY: ${MAX_SUBMISSIONS_PER_DAY:-500}
+      EXECUTOR_TIMEOUT_MS: ${EXECUTOR_TIMEOUT_MS:-30000}
+      EXECUTOR_MEMORY_LIMIT_MB: ${EXECUTOR_MEMORY_LIMIT_MB:-128}
+      EXECUTOR_CPU_LIMIT: ${EXECUTOR_CPU_LIMIT:-0.5}
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
       - app_logs:/app/logs
@@ -116,11 +125,17 @@ services:
     restart: unless-stopped
     environment:
       NODE_ENV: ${ENV:-development}
-      MONGODB_URI: mongodb://${MONGO_USERNAME:-admin}:${MONGO_PASSWORD:-devpassword}@mongodb:27017/${MONGO_DB:-rce_system}?authSource=admin
+      MONGO_USERNAME: ${MONGO_USERNAME:-admin}
+      MONGO_PASSWORD: ${MONGO_PASSWORD:-devpassword}
+      MONGO_DB: ${MONGO_DB:-safeexec_dev}
+      MONGODB_URI: mongodb://${MONGO_USERNAME:-admin}:${MONGO_PASSWORD:-devpassword}@mongodb:27017/${MONGO_DB:-safeexec_dev}?authSource=admin
       REDIS_URI: redis://${REDIS_PASSWORD:+:${REDIS_PASSWORD}@}redis:6379
       JWT_SECRET: ${JWT_SECRET:-dev-jwt-secret-change-in-production}
       DOCKER_HOST: /var/run/docker.sock
       LOG_LEVEL: ${LOG_LEVEL:-info}
+      EXECUTOR_TIMEOUT_MS: ${EXECUTOR_TIMEOUT_MS:-30000}
+      EXECUTOR_MEMORY_LIMIT_MB: ${EXECUTOR_MEMORY_LIMIT_MB:-128}
+      EXECUTOR_CPU_LIMIT: ${EXECUTOR_CPU_LIMIT:-0.5}
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
       - app_logs:/app/logs

src/config/env.ts

@@ -4,7 +4,6 @@ configDotenv();
 
 export const config = {
   port: process.env.PORT || 5000,
-  mongoUri: process.env.MONGO_URI || 'mongodb://localhost:27017/rce',
-  redisHost: process.env.REDIS_HOST || 'localhost',
-  redisPort: Number(process.env.REDIS_PORT) || 6379,
+  mongoUri: process.env.MONGODB_URI || 'mongodb://localhost:27017/rce',
+  redisUri: process.env.REDIS_URI || 'redis://localhost:6379',
 };

src/queue/queue.ts

@@ -1,10 +1,17 @@
 // src/queue/queue.ts
 import { Queue } from 'bullmq';
-import { config } from '../config/env';
+import { environmentConfig } from '../config/environment';
+
+const config = environmentConfig.getConfig();
 
 export const submissionQueue = new Queue('submission', {
   connection: {
-    host: config.redisHost,
-    port: config.redisPort,
+    host: config.redis.uri.includes('://')
+      ? new URL(config.redis.uri).hostname
+      : config.redis.uri.split(':')[0],
+    port: config.redis.uri.includes('://')
+      ? parseInt(new URL(config.redis.uri).port) || 6379
+      : parseInt(config.redis.uri.split(':')[1]) || 6379,
+    ...(config.redis.password && { password: config.redis.password }),
   },
 });

src/queue/worker.ts

@@ -1,9 +1,11 @@
 // src/queue/worker.ts
 import { Worker } from 'bullmq';
-import { config } from '../config/env';
+import { environmentConfig } from '../config/environment';
 import { SubmissionModel } from '../models/submission.model';
 import { executeInDocker } from '../executors/dockerExecutor';
 
+const config = environmentConfig.getConfig();
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const worker = new Worker(
   'submission',
@@ -17,7 +19,7 @@ const worker = new Worker(
       _id: submission._id.toString(),
       code: submission.code,
       language: submission.language,
-      timeLimitMs: 10000,
+      timeLimitMs: config.executor.timeoutMs,
       save: async () => {
         await submission.save();
       },
@@ -27,8 +29,13 @@ const worker = new Worker(
   },
   {
     connection: {
-      host: config.redisHost,
-      port: config.redisPort,
+      host: config.redis.uri.includes('://')
+        ? new URL(config.redis.uri).hostname
+        : config.redis.uri.split(':')[0],
+      port: config.redis.uri.includes('://')
+        ? parseInt(new URL(config.redis.uri).port) || 6379
+        : parseInt(config.redis.uri.split(':')[1]) || 6379,
+      ...(config.redis.password && { password: config.redis.password }),
     },
   }
 );