fisrt_commit

.env.example

@@ -1,56 +1,38 @@
-# REDIS_URL=redis://redis:6379
-# REDIS_URL=redis://localhost:6379
-# DATABASE_URL=postgresql://volunchain:volunchain123@db:5432/volunchain
-DATABASE_URL=postgresql://volunchain:volunchain123@localhost:5434/volunchain
+# Core Environment Variables
+NODE_ENV=development
 PORT=3000
-JWT_SECRET=your-jwt-secret
-JWT_SECRET=Zq0gGppr1PIqJsYbCJptI+xmgVvd3BViQUEw2nvsiBs=
-DB_TYPE=postgres
-# DB_HOST=db
-# DB_PORT=5432
-DB_HOST=localhost
-DB_PORT=5434
-
-# DIRECT_URL=DATABASE_URL=postgresql://user:password@localhost:5432/volunchain?schema=public&connection_limit=10&pool_timeout=30&idle_timeout=30
-DIRECT_URL=postgresql://volunchain:volunchain123@localhost:5434/volunchain
-DATABASE_CONNECTION_LIMIT=10
-DATABASE_POOL_TIMEOUT=30
-DATABASE_IDLE_TIMEOUT=30
-DATABASE_CONNECTION_TIMEOUT=10
-ENABLE_QUERY_LOGGING=true
-QUERY_TIMEOUT=30000
-
-
-DB_USER=volunchain
-DB_PASSWORD=volunchain123
-DB_NAME=volunchain
-NODE_ENV="development"
-BACKBLAZE_APPLICATION_KEY_ID=
-BACKBLAZE_APPLICATION_KEY=
-BACKBLAZE_BUCKET_ID=
 
-RATE_LIMIT_MAX_REQUESTS=100
-RATE_LIMIT_WINDOW_MINUTES=5
+# Database
+DATABASE_URL=postgresql://user:password@localhost:5432/volunchain
 
-RATE_LIMIT_AUTH_MAX=10
-RATE_LIMIT_AUTH_WINDOW=3
+# JWT / Security
+JWT_SECRET=your_jwt_secret
 
-RATE_LIMIT_WALLET_MAX=50
-RATE_LIMIT_WALLET_WINDOW=5
+# Supabase
+SUPABASE_URL=https://your-supabase-url.supabase.co
+SUPABASE_ANON_KEY=your_supabase_anon_key
 
-RATE_LIMIT_EMAIL_MAX=20
-RATE_LIMIT_EMAIL_WINDOW=5
+# Redis
+REDIS_URL=redis://localhost:6379
 
-RATE_LIMIT_DEFAULT_MAX=100
-RATE_LIMIT_DEFAULT_WINDOW=5
+# Stellar / Horizon
+HORIZON_URL=https://horizon-testnet.stellar.org
+STELLAR_NETWORK=testnet
 
-AWS_ACCESS_KEY_ID=your-access-key-here
-AWS_SECRET_ACCESS_KEY=your-secret-access-key
-AWS_REGION=eu-north-1
-S3_BUCKET_NAME=volunchain-certificates-test
-SOROBAN_RPC_URL=your_rpc_url
-SOROBAN_SERVER_SECRET=your_server_secret
+# Email
+EMAIL_SERVICE=gmail
+[email protected]
+EMAIL_PASSWORD=your_email_password
+BASE_URL=http://localhost:3000
 
-# Supabase
-SUPABASE_URL=https://your-project.supabase.co
-SUPABASE_ANON_KEY=your-anon-key
+# Soroban
+SOROBAN_RPC_URL=https://soroban-testnet.stellar.org
+SOROBAN_SERVER_SECRET=your_soroban_server_secret
+
+# Rate Limiting
+RATE_LIMIT_WINDOW_MS=900000
+RATE_LIMIT_MAX_REQUESTS=100
+RATE_LIMIT_MESSAGE=Too many requests, please try again later.
+
+# Email Verification
+EMAIL_SECRET=your_email_verification_secret

package.json

@@ -39,6 +39,7 @@
     "cors": "^2.8.5",
     "date-fns": "^4.1.0",
     "dotenv": "^16.4.7",
+    "env-var": "^7.5.0",
     "express": "^4.21.2",
     "express-rate-limit": "^7.5.0",
     "express-validator": "^7.2.0",

readme.md

@@ -1,3 +1,4 @@
+
 # VolunChain
 
 **Innovating Volunteering with Blockchain ��**
@@ -576,3 +577,21 @@ Run wallet verification tests:
 ```bash
 npm test -- --testPathPattern=wallet
 ```
+
+## ⚠️ Environment Validation & Startup Errors
+
+VolunChain validates all required environment variables at startup. If any required variable is missing or invalid, the application will fail to start and display a clear error message indicating which variable is missing.
+
+**Common startup failure messages:**
+- `DATABASE_URL environment variable is required`
+- `JWT_SECRET environment variable is required`
+- `SUPABASE_URL environment variable is required`
+- `SUPABASE_ANON_KEY environment variable is required`
+- `EMAIL_USER environment variable is required`
+- `EMAIL_PASSWORD environment variable is required`
+- `SOROBAN_SERVER_SECRET environment variable is required`
+
+**How to fix:**  
+Check your `.env` file and ensure all required variables are set. See `.env.example` for a complete list of required variables and example values.
+
+If you see a startup error, update your `.env` file and restart the application.

src/config/env.ts

@@ -0,0 +1,34 @@
+import { get } from "env-var";
+
+// Use 'get' directly instead of 'env.get'
+export const env = {
+  NODE_ENV: get("NODE_ENV").default("development").asString(),
+  PORT: get("PORT").default("3000").asPortNumber(),
+
+  // Database
+  DATABASE_URL: get("DATABASE_URL").required().asUrlString(),
+
+  // JWT / Security
+  JWT_SECRET: get("JWT_SECRET").required().asString(),
+
+  // Supabase
+  SUPABASE_URL: get("SUPABASE_URL").required().asUrlString(),
+  SUPABASE_ANON_KEY: get("SUPABASE_ANON_KEY").required().asString(),
+
+  // Redis
+  REDIS_URL: get("REDIS_URL").default("redis://localhost:6379").asString(),
+
+  // Stellar / Horizon
+  HORIZON_URL: get("HORIZON_URL").default("https://horizon-testnet.stellar.org").asUrlString(),
+  STELLAR_NETWORK: get("STELLAR_NETWORK").default("testnet").asString(),
+
+  // Email
+  EMAIL_SERVICE: get("EMAIL_SERVICE").default("gmail").asString(),
+  EMAIL_USER: get("EMAIL_USER").required().asString(),
+  EMAIL_PASSWORD: get("EMAIL_PASSWORD").required().asString(),
+  BASE_URL: get("BASE_URL").default("http://localhost:3000").asUrlString(),
+
+  // Soroban
+  SOROBAN_RPC_URL: get("SOROBAN_RPC_URL").required().asUrlString(),
+  SOROBAN_SERVER_SECRET: get("SOROBAN_SERVER_SECRET").required().asString(),
+};

src/config/horizon.config.ts

@@ -1,10 +1,11 @@
 import dotenv from "dotenv";
+import { env } from "./env";
 
 dotenv.config();
 
 export const horizonConfig = {
-  url: process.env.HORIZON_URL || "https://horizon-testnet.stellar.org",
-  network: process.env.STELLAR_NETWORK || "testnet",
+  url: env.HORIZON_URL || "https://horizon-testnet.stellar.org",
+  network: env.STELLAR_NETWORK || "testnet",
   timeout: 30000, // 30 seconds timeout for API calls
 };
 

src/config/prisma.ts

@@ -1,13 +1,14 @@
 import { PrismaClient } from "@prisma/client";
 import { DatabaseMonitor } from "../utils/db-monitor";
+import { env } from "./env";
 
 // Configure Prisma Client with connection pooling
 const prismaClientSingleton = () => {
   return new PrismaClient({
     log: ["query", "info", "warn", "error"],
     datasources: {
       db: {
-        url: process.env.DATABASE_URL,
+        url: env.DATABASE_URL,
       },
     },
   });
@@ -23,7 +24,7 @@ const prisma = globalThis.prisma ?? prismaClientSingleton();
 // Initialize database monitor
 export const dbMonitor = new DatabaseMonitor(prisma);
 
-if (process.env.NODE_ENV !== "production") {
+if (env.NODE_ENV !== "production") {
   globalThis.prisma = prisma;
 }
 

src/config/redis.ts

@@ -1,7 +1,8 @@
 import { createClient, RedisClientType } from "redis";
+import { env } from "./env";
 
 const redisClient = createClient({
-  url: process.env.REDIS_URL || "redis://localhost:6379",
+  url: env.REDIS_URL || "redis://localhost:6379",
 }) as RedisClientType & {
   incr: (key: string) => Promise<number>;
   expire: (key: string, seconds: number) => Promise<number>;

src/config/soroban.config.ts

@@ -1,10 +1,11 @@
 import dotenv from "dotenv";
+import { env } from "./env";
 
 dotenv.config();
 
 export const sorobanConfig = {
-  rpcUrl: process.env.SOROBAN_RPC_URL || "https://soroban-testnet.stellar.org",
-  serverSecret: process.env.SOROBAN_SERVER_SECRET,
+  rpcUrl: env.SOROBAN_RPC_URL || "https://soroban-testnet.stellar.org",
+  serverSecret: env.SOROBAN_SERVER_SECRET,
 };
 
 // Validate required environment variables

src/config/supabase.ts

@@ -1,6 +1,7 @@
 import { createClient } from '@supabase/supabase-js';
+import { env } from "./env";
 
-const supabaseUrl = process.env.SUPABASE_URL!;
-const supabaseKey = process.env.SUPABASE_ANON_KEY!;
+const supabaseUrl = env.SUPABASE_URL!;
+const supabaseKey = env.SUPABASE_ANON_KEY!;
 
 export const supabase = createClient(supabaseUrl, supabaseKey);

src/config/swagger.config.ts

@@ -2,14 +2,15 @@ import swaggerUi from "swagger-ui-express";
 import YAML from "yaml";
 import { Express } from "express";
 import fs from "fs";
+import { env } from "./env";
 
 export class SwaggerConfig {
   private static swaggerDocument = YAML.parse(
     fs.readFileSync("./openapi.yaml", "utf8")
   );
 
   static setup(app: Express): void {
-    if (process.env.NODE_ENV !== "development") {
+    if (env.NODE_ENV !== "development") {
       console.log("⚠️ Swagger is disabled in production mode.");
       return;
     }

src/config/winston.config.ts

@@ -1,5 +1,6 @@
 import winston from "winston";
 import path from "path";
+import { env } from "./env";
 
 const { combine, timestamp, errors, json, printf } = winston.format;
 
@@ -17,8 +18,8 @@ const consoleFormat = printf(
 const logsDir = path.join(process.cwd(), "logs");
 
 const createLogger = () => {
-  const isProduction = process.env.NODE_ENV === "production";
-  const isDevelopment = process.env.NODE_ENV === "development";
+  const isProduction = env.NODE_ENV === "production";
+  const isDevelopment = env.NODE_ENV === "development";
 
   const transports: winston.transport[] = [];
 

src/index.ts

@@ -23,13 +23,14 @@ import organizationRoutes from "./routes/OrganizationRoutes";
 import messageRoutes from "./modules/messaging/routes/messaging.routes";
 import testRoutes from "./routes/testRoutes";
 import { Logger } from "./utils/logger";
+import { env } from "../src/config/env";
 
 const globalLogger = new Logger("VolunChain");
 import fs from "fs";
 import path from "path";
 
 const app = express();
-const PORT = process.env.PORT || 3000;
+const PORT = env.PORT;
 const ENV = process.env.NODE_ENV || "development";
 
 // Ensure logs directory exists