feat: add .env example

.env.example

@@ -0,0 +1,10 @@
+# MongoDB connection string
+MONGO_URI=mongodb://root:example@localhost:27017/phoenix?authSource=admin
+# Server port
+PORT=4000
+# Your unique JWT secret
+JWT_SECRET=your_jwt_secret
+# Log level
+LOG_LEVEL=debug
+
+KAFKAJS_NO_PARTITIONER_WARNING=1

README.md

@@ -26,9 +26,11 @@ To install dependencies:
 bun install
 ```
 
-To run:
+
+To create .env file and run:
 
 ```bash
+cp .env.example .env
 bun run start
 ```
 

e2e-tests/setup.ts

@@ -5,8 +5,9 @@ import { ApolloServer } from 'apollo-server-express';
 import jwt from 'jsonwebtoken';
 import PluginLoader from '../src/plugins/plugin-loader'; // Adjust the path as needed
 import { setMongoServer } from './teardown';
+import env from '../src/config/config';
 
-const JWT_SECRET = process.env.JWT_SECRET || 'your_jwt_secret';
+const JWT_SECRET = env.JWT_SECRET || 'your_jwt_secret';
 
 let server: ApolloServer;
 let app: express.Application;

src/config/config.ts

@@ -5,13 +5,15 @@ import dotenv from 'dotenv';
 dotenv.config();
 
 const env = cleanEnv(process.env, {
-  MONGO_URI: str({ desc: 'MongoDB connection string' }),
+  MONGO_URI: str({ desc: 'MongoDB connection string',
+    default: "mongodb://root:example@localhost:27017/phoenix?authSource=admin" }),
   PORT: port({ default: 4000 }),
-  JWT_SECRET: str({ desc: 'Secret key for JWT token' }),
+  JWT_SECRET: str({ desc: 'Secret key for JWT token', default: 'your-secret'}),
   JTW_EXPIRY: str({ default: '1y' }),
   MODE: str({ choices: ['server', 'worker', 'dev'], default: 'dev' }),
   REDIS_HOST: str({ default: 'localhost' }),
   REDIS_PORT: port({ default: 6379 }),
+  KAFKA_BROKER: str({ default: 'localhost:29092' }),
 });
 
 export default env;

src/event/kafka-event-service.ts

@@ -1,5 +1,6 @@
 import { Kafka, type Producer, type Consumer } from 'kafkajs';
 import { Container, Service } from 'typedi';
+import env from '../config/config.ts';
 
 @Service()
 class KafkaEventService {
@@ -12,7 +13,7 @@ class KafkaEventService {
   constructor() {
     this.kafka = new Kafka({
       clientId: 'my-app',
-      brokers: [process.env.KAFKA_BROKER || 'localhost:29092'], // Use environment variable or default to localhost
+      brokers: [env.KAFKA_BROKER || 'localhost:29092'], // Use environment variable or default to localhost
     });
 
     this.producer = this.kafka.producer();

src/middleware/auth.ts

@@ -1,6 +1,7 @@
 import type { Request, Response, NextFunction } from 'express';
 import jwt, { type JwtPayload } from 'jsonwebtoken';
 import logger from '../config/logger.ts';
+import env from '../config/config.ts';
 
 const loggerCtx = { context: 'auth-middleware' };
 
@@ -18,7 +19,7 @@ export const authenticate = (req: Request, res: Response, next: NextFunction) =>
   }
 
   try {
-    const secret = process.env.JWT_SECRET;
+    const secret = env.JWT_SECRET;
     if (!secret) {
       throw new Error('JWT_SECRET is not defined');
     }

src/plugins/auth-plugin/resolvers/auth-resolver.ts

@@ -40,7 +40,7 @@ export class AuthResolver {
       throw new Error('Invalid credentials');
     }
 
-    const token = jwt.sign({ role: user.role, id: user._id }, process.env.JWT_SECRET!, { expiresIn: env.JTW_EXPIRY });
+    const token = jwt.sign({ role: user.role, id: user._id }, env.JWT_SECRET!, { expiresIn: env.JTW_EXPIRY });
     return token;
   }
 

src/plugins/sample-plugin/index.ts

@@ -7,6 +7,7 @@ import { SampleService } from './services/sample-service';
 import KafkaEventService from '../../event/kafka-event-service';
 import { Queue, Job } from 'bullmq';
 import logger from '../../config/logger.ts';
+import env from '../../config/config.ts';
 
 const loggerCtx = { context: 'sample-plugin/index' };
 
@@ -27,8 +28,8 @@ export default {
     // Define and register the queue for this plugin
     const sampleQueue = new Queue('sampleQueue', {
       connection: {
-        host: process.env.REDIS_HOST || 'localhost',
-        port: Number(process.env.REDIS_PORT) || 6379,
+        host: env.REDIS_HOST || 'localhost',
+        port: Number(env.REDIS_PORT) || 6379,
       },
     });
 
@@ -56,8 +57,8 @@ export default {
       processor: sampleJobProcessor,
       options: {
         connection: {
-          host: process.env.REDIS_HOST || 'localhost',
-          port: Number(process.env.REDIS_PORT) || 6379,
+          host: env.REDIS_HOST || 'localhost',
+          port: Number(env.REDIS_PORT) || 6379,
         },
       },
     };