managing global configuration

.gitignore

@@ -42,7 +42,7 @@ node_modules/
 jspm_packages/
 
 # Configuration file
-src/config.ts
+config/default.json
 
 # TypeScript v1 declaration files
 typings/

README.md

@@ -15,7 +15,7 @@
 - Install dependencies: ``` npm install ```
 
 
-**Note:** Make sure to add a `config.js` file in the `src` folder. See the `config.example.js` under `src/` directory for more details.
+**Note:** Make sure to add a `default.json` file in the `config` folder. Refer to `config/example.json` for an example. For production, create a `production.json` and follow the same format.
 
 
 

config/example.json

@@ -0,0 +1,12 @@
+{
+	"app": {
+		"PORT": 4000,
+		"auth": {
+			"secretKey": "<Your Secret Here>",
+			"tokenExpiry": 1
+        }
+    },
+    "db": {
+        "mongoUrl": "mongodb://127.0.0.1:27017/posterior"
+    }
+}

package.json

@@ -32,6 +32,7 @@
   },
   "homepage": "https://github.com/pes-alcoding-club/posterior#readme",
   "dependencies": {
+    "config": "^3.3.1",
     "express": "^4.17.1",
     "jsonwebtoken": "^8.5.1",
     "mongoose": "^5.9.22",
@@ -41,6 +42,7 @@
     "passport-local-mongoose": "^6.0.1"
   },
   "devDependencies": {
+    "@types/config": "0.0.36",
     "@types/express": "^4.17.7",
     "@types/mongoose": "^5.7.31",
     "@types/node": "^14.0.22",

src/app.ts

@@ -3,7 +3,7 @@ import mongoose from 'mongoose';
 
 import passport from 'passport';
 
-import config from './config';
+import config from 'config';
 
 import AuthRouter from './routers/auth.router';
 
@@ -12,18 +12,22 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: false }));
 app.use(passport.initialize());
 
-app.listen(config.PORT, (err: any) => {
+const appConfig : any  = config.get('app');
+
+app.listen(appConfig.PORT, (err: any) => {
 	if (err) {
 		console.error(`Unable to start app. Found error: ${err.message}`);
 		return;
 	}
-	console.error(`Server Running at PORT: ${config.PORT}`);
+	console.error(`Server Running at PORT: ${appConfig.PORT}`);
 });
 
 app.use('/api/auth', AuthRouter);
 
+const dbConfig : any = config.get('db');
+
 mongoose.set('useCreateIndex', true);
-mongoose.connect(config.mongoUrl, {
+mongoose.connect(dbConfig.mongoUrl, {
 	useNewUrlParser: true,
 	useUnifiedTopology: true
 });

src/middleware/auth.middleware.ts

@@ -8,17 +8,19 @@ const ExtractJwt = passportJwt.ExtractJwt;
 
 import User from '../models/user.model';
 
-import config from '../config';
+import config from 'config';
 
 import { NextFunction } from 'express';
 
 export const local = passport.use(new LocalStrategy(User.authenticate()));
 passport.serializeUser(User.serializeUser());
 passport.deserializeUser(User.deserializeUser());
 
+const authConfig : any = config.get('app.auth');
+
 const opts = {
 	jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
-	secretOrKey: config.secretKey
+	secretOrKey: authConfig.secretKey
 };
 
 export const jwtPasport = passport.use(

src/utils/auth.util.ts

@@ -1,6 +1,8 @@
 import jwt from 'jsonwebtoken';
-import config from '../config';
+import config from 'config';
+
+const authConfig : any = config.get('app.auth');
 
 export const getToken = function (user: any) {
-	return jwt.sign(user, config.secretKey, { expiresIn: 30 * 24 * 3600 }); // Expires in 30 days
+	return jwt.sign(user, authConfig.secretKey, { expiresIn: authConfig.tokenExpiry * 24 * 3600 });
 };