catalyst-core 0.0.1-beta.2 → 0.0.1-beta.3

package/README.md

@@ -5,7 +5,7 @@ Frontend framework with server rendering support for web applications.
 ## Table of Contents 
 
 - Overview
-- Initial setup
+- Installation
 - Data Fetching with Catalyst
     - serverFetcher
     - clientFetcher
@@ -17,28 +17,41 @@ Frontend framework with server rendering support for web applications.
 This package provides a way to proxy your request through your server. It allows you to cache your incoming request to improve your server response time.
 
 
-## Initial Setup 
-Run the following commands in the directory where you want to scaffold catalyst app.
+## Installation
 
-```js
-npx create-catalyst-app
-```
+**System Requirements**
+
+- Node version 20.4.0 or later
+- macOS and Linux are supported
 
-if this steps fails, make sure .npmrc file exists and token used is a valid one.
 
-If successful, cli for setup will appear.
+**Automatic Installation**
 
-Select js for the language and Redux for state management option. (we’ll be adding ts support soon) 
+- Run the following commands in the directory where you want to set up the Catalyst app.
 
-After selecting options
 ```js
-cd my-app && npm i
+npx create-catalyst-app@latest
 ```
-For starting the project
+
+If successful, you will see the following prompts in your terminal.
+
+- Enter the name of your Catalyst application.
+- Choose state management.
+- Once packages are installed,start the development server by running the following command.
+
 ```js
-npm run start
+cd project-name && npm run start
 ```
 
+- Navigate to http://localhost:3005
+
+The dev server should be running now.
+
+Visit our official documentation: 
+https://catalyst.1mg.com/public_docs/content/installation
+
+
+
 ## Data Fetching with Catalyst 
 
 we have serverFetcher function for fetching with SSR and clientFetcher function for fetching during client side rendering and navigations.

package/bin/catalyst.js

@@ -6,11 +6,11 @@ process.on('unhandledRejection', err => {
 const { spawnSync } = require('node:child_process');
 const args = process.argv.slice(2);
 const scriptIndex = args.findIndex(
-  x => x === 'build' || x === 'start' || x=== 'prepare' || x=== 'serve'
+  x => x === 'build' || x === 'start' || x=== 'serve'
 );
 const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
 const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : [];
-if (['build', 'start', 'prepare', 'serve'].includes(script)) {
+if (['build', 'start', 'serve'].includes(script)) {
   const result = spawnSync(
     process.execPath,
     nodeArgs
@@ -37,5 +37,4 @@ if (['build', 'start', 'prepare', 'serve'].includes(script)) {
   process.exit(result.status);
 } else {
   console.log('Unknown script "' + script + '".');
-  console.log('Perhaps you need to update framework?');
 }

package/config.json

@@ -1,7 +1,6 @@
 {
     "cssModulesIdentifierDev": "[name]__[local]",
     "cssModulesIdentifierProd": "[name]__[local]__[hash:base64:5]",
-    "analyzeBundle": false,
     "chunkFileNameDev": "[name].bundle.js",
     "chunkFileNameProd": "[name].[contenthash].js",
     "cssChunkFileName": "[name].[contenthash].css"

package/{LICENSE → license}

@@ -6,4 +6,5 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/{logger/index.js → logger.js}

@@ -10,13 +10,13 @@ const {
 } = winston;
 
 /**
- * @description Logger library with rotational strategy. Creates a logs folder in root. 
+ * @description Logger library with rotational strategy. Creates a logs folder in root.
  *              With debug, error and info log directories with their respective log files.
- * 
+ *
  * @format Logstash with timestamp
  * @param config { @enableDebugLogs: Bool // default: true }
  * @returns loggerInstance
- *  
+ *
  */
 const configureLogger = (config = {}) => {
   const {
@@ -25,7 +25,7 @@ const configureLogger = (config = {}) => {
     enableConsoleLogging = true
   } = config;
   const consoleTransport = new transports.Console({
-    level: 'debug'
+    level: "debug"
   });
   const fileTransport = (type = "info") => {
     return new DailyRotateFile({
@@ -39,7 +39,7 @@ const configureLogger = (config = {}) => {
   };
   const infoLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "info"
@@ -47,7 +47,7 @@ const configureLogger = (config = {}) => {
   });
   const debugLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "debug"
@@ -55,7 +55,7 @@ const configureLogger = (config = {}) => {
   });
   const errorLogger = createLogger({
     format: format.combine(format.timestamp({
-      format: 'YYYY-MM-DD HH:mm:ss'
+      format: "YYYY-MM-DD HH:mm:ss"
     }), format.json()),
     defaultMeta: {
       loglevel: "error"
@@ -67,9 +67,9 @@ const configureLogger = (config = {}) => {
     errorLogger.add(consoleTransport);
   }
   if (enableFileLogging && JSON.parse(enableFileLogging)) {
-    infoLogger.add(fileTransport('info'));
-    debugLogger.add(fileTransport('debug'));
-    errorLogger.add(fileTransport('error'));
+    infoLogger.add(fileTransport("info"));
+    debugLogger.add(fileTransport("debug"));
+    errorLogger.add(fileTransport("error"));
   }
   const Logger = {
     debug: () => {},

package/package.json

@@ -1,18 +1,24 @@
 {
    "name": "catalyst-core",
-   "version": "0.0.1-beta.2",
+   "version": "0.0.1-beta.3",
    "main": "index.js",
-   "description": "1mg framework around react",
+   "description": "Web framework that provides great performance out of the box",
    "bin": {
-      "catalyst": "./bin/catalyst.js"
+      "catalyst": "bin/catalyst.js"
    },
    "scripts": {
       "prepare": "babel src --out-dir . ",
-      "start": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./webpack/development.client.babel & npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./server/mainIndex.js --watch-path=${npm_config_src_path}/server --watch-path=${npm_config_src_path}/src --ignore=' '",
-      "build": "rm -rf ${npm_config_src_path}/build & node ./scripts/loadScriptsBeforeServerStarts.js & APPLICATION=${npm_config_app_name} NODE_ENV=production  webpack --config ./webpack/production.client.babel.js --progress && APPLICATION=${npm_config_app_name} NODE_ENV=production SSR=true webpack --config ./webpack/production.ssr.babel.js --progress && APPLICATION=${npm_config_app_name} NODE_ENV=production npx babel ./server --out-dir ${npm_config_src_path}/build --ignore '**/*.test.js,./server/renderer/handler.js' && APPLICATION=${npm_config_app_name} npx babel ${npm_config_src_path}/server --out-dir ${npm_config_src_path}/build ",
-      "serve": "APPLICATION=${npm_config_app_name} NODE_ENV=production node -r ./scripts/loadScriptsBeforeServerStarts.js ${npm_config_src_path}/build/mainIndex.js"
+      "start": "node ./scripts/checkVersion && npm run start:client & npm run start:server",
+      "start:client": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js webpack/development.client.babel --no-warnings=ExperimentalWarning --no-warnings=BABEL",
+      "start:server": "npx babel-node -r ./scripts/loadScriptsBeforeServerStarts.js ./server/startServer.js --watch-path=${npm_config_src_path}/server --watch-path=${npm_config_src_path}/src --ignore='__IGNORE__' --no-warnings=ExperimentalWarning --no-warnings=BABEL",
+      "build": "node ./scripts/checkVersion && npm run build:prepare && npm run build:client && npm run build:ssr && npm run build:server",
+      "build:prepare": "rm -rf ${npm_config_src_path}/${build_output_path} & node ./scripts/loadScriptsBeforeServerStarts.js",
+      "build:client": "APPLICATION=${npm_config_app_name} NODE_ENV=production  webpack --config ./webpack/production.client.babel.js --progress",
+      "build:ssr": "APPLICATION=${npm_config_app_name} NODE_ENV=production SSR=true webpack --config ./webpack/production.ssr.babel.js --progress",
+      "build:server": "APPLICATION=${npm_config_app_name} NODE_ENV=production npx babel ./server --out-dir ${npm_config_src_path}/${build_output_path} --ignore '**/*.test.js,./server/renderer/handler.js' && APPLICATION=${npm_config_app_name} npx babel ${npm_config_src_path}/server --out-dir ${npm_config_src_path}/${build_output_path}",
+      "serve": "APPLICATION=${npm_config_app_name} NODE_ENV=production node -r ./scripts/loadScriptsBeforeServerStarts.js ${npm_config_src_path}/${build_output_path}/startServer.js",
+      "prepublishOnly": "npm i && npm run prepare"
    },
-   "author": "",
    "license": "MIT",
    "dependencies": {
       "@babel/cli": "^7.23.0",
@@ -29,11 +35,8 @@
       "@loadable/webpack-plugin": "^5.15.2",
       "@pmmmwh/react-refresh-webpack-plugin": "^0.5.11",
       "@svgr/webpack": "^8.1.0",
-      "@tata1mg/router": "^0.0.1-alpha.13",
-      "acorn-loose": "^8.4.0",
+      "@tata1mg/router": "^0.0.1-beta.0",
       "app-root-path": "^3.1.0",
-      "aws-sdk": "^2.1490.0",
-      "axios": "^0.19.2",
       "babel-loader": "^9.1.3",
       "babel-plugin-dynamic-import-node": "^2.3.3",
       "babel-plugin-syntax-dynamic-import": "^6.18.0",
@@ -42,24 +45,20 @@
       "babel-plugin-transform-export-extensions": "^6.22.0",
       "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
       "body-parser": "^1.20.2",
+      "chokidar": "^3.6.0",
       "compression": "^1.7.4",
       "cookie-parser": "^1.4.6",
       "css-hot-loader": "^1.4.4",
       "css-loader": "^6.8.1",
       "css-modules-require-hook": "^4.2.3",
-      "dotenv-webpack": "^8.0.1",
-      "esm-module-alias": "^2.0.3",
       "express": "^4.18.2",
       "express-static-gzip": "^2.1.7",
       "file-loader": "^6.2.0",
-      "helmet": "^7.0.0",
       "html-loader": "^4.2.0",
       "img-loader": "^4.0.0",
       "isomorphic-dompurify": "^1.13.0",
-      "lodash.template": "^4.5.0",
       "mini-css-extract-plugin": "^2.7.6",
       "module-alias": "^2.2.3",
-      "node-dev": "^7.4.3",
       "picocolors": "^1.0.0",
       "postcss-loader": "^7.3.3",
       "react": "^18.2.0",
@@ -68,17 +67,16 @@
       "react-refresh": "^0.14.0",
       "react-router-dom": "^6.16.0",
       "redux": "^4.2.1",
-      "redux-logger": "^3.0.6",
-      "redux-thunk": "^2.4.2",
       "sass": "^1.69.5",
       "sass-loader": "^13.3.2",
       "sass-resources-loader": "^2.2.5",
       "ua-parser-js": "^1.0.37",
+      "url": "^0.11.3",
       "url-loader": "^4.1.1",
       "webpack": "^5.88.2",
       "webpack-bundle-analyzer": "^4.9.1",
       "webpack-cli": "^5.1.4",
-      "webpack-dev-server": "^4.15.1",
+      "webpack-dev-server": "^4.15.2",
       "webpack-merge": "^5.9.0",
       "webpack-node-externals": "^3.0.0",
       "winston": "^3.11.0",

package/packages/create-framework-app/templates/redux-js/node_modules/catalyst/src/router.js

@@ -0,0 +1 @@
+export * from '@tata1mg/router'

package/router/ClientRouter.js

@@ -4,12 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _reactRouterDom = require("react-router-dom");
-var _index = require("@src/js/routes/index.js");
-// FRAMEWORK COMMENT THIS IS JUST FOR THE APP
-
+var _router = require("@tata1mg/router");
+var _utils = require("@routes/utils.js");
 /**
  * @returns returns browsers routers (client routes)
-*/
-const clientRouter = () => (0, _reactRouterDom.createBrowserRouter)((0, _index.preparedRoutes)());
+ */
+const clientRouter = ({
+  store,
+  routerInitialState
+}) => (0, _router.createBrowserRouter)((0, _utils.preparedRoutes)({
+  store,
+  routerInitialState
+}));
 var _default = exports.default = clientRouter;

package/router/ServerRouter.js

@@ -5,22 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _router = require("@tata1mg/router");
-// FRAMEWORK COMMENT THIS IS JUST FOR THE APP
-const {
-  preparedRoutes
-} = require(`${process.env.src_path}/src/js/routes/index.js`);
-
-/**
- * @description return
- * @param {object} reduxData - redux data
- * @returns returns server routes
- */
+var _utils = require("@routes/utils.js");
 const ServerRouter = reduxData => {
   const {
     store,
     intialData
   } = reduxData;
-  return (0, _router.useRoutes)(preparedRoutes({
+  return (0, _router.useRoutes)((0, _utils.preparedRoutes)({
     store,
     routerInitialState: intialData
   }));

package/scripts/build.js

@@ -6,21 +6,27 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 const {
-  spawnSync,
-  execSync
+  spawnSync
 } = require("child_process");
 const path = require("path");
 const {
   name
 } = require(`${process.env.PWD}/package.json`);
+const {
+  BUILD_OUTPUT_PATH
+} = require(`${process.env.PWD}/config/config.json`);
+
+/**
+ * @description - creates a production build of the application.
+ */
 function start() {
-  console.log("Running start....");
   const dirname = path.resolve(__dirname, "../");
   spawnSync("npm", ["run", "build", `--src_path=${process.env.PWD}`, `--app_name=${name || "catalyst_app"}`], {
     cwd: dirname,
     stdio: "inherit",
     env: _objectSpread(_objectSpread({}, process.env), {}, {
-      src_path: process.env.PWD
+      src_path: process.env.PWD,
+      build_output_path: BUILD_OUTPUT_PATH
     })
   });
 }

package/scripts/checkVersion.js

@@ -0,0 +1,5 @@
+"use strict";
+
+if (process.versions.node.split(".")[0] < 20) {
+  console.error("\x1b[31m%s\x1b[0m", "use node version >=20");
+}

package/scripts/loadEnvironmentVariables.js

@@ -4,34 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-const catalystConfig = require("../config/config.js");
+const appConfig = require(`${process.env.src_path}/config/config.json`);
 const {
-  validatePackageJson,
   validateConfigFile
-} = require("../scripts/validator");
-const envConfig = require(`${process.env.src_path}/config/config.json`);
-const packageJSON = require(`${process.env.src_path}/package.json`);
-const env = process.env.NODE_ENV || "developmemt";
-const config = _objectSpread(_objectSpread({}, catalystConfig), validateConfigFile(envConfig) ? envConfig : {});
+} = require("./validator.js");
 
 /**
  * @description stores all config.json key value into process.env before server starts.
  */
 const loadEnvironmentVariables = () => {
-  process.env.BUILD_NUMBER = validatePackageJson(packageJSON) ? packageJSON.assetVersion : "";
-  for (let k in envConfig) {
-    // below code provides support for object handling present in config. However, for usage on client the client logic in define plugin needs to be checked and updated
-    process.env[k] = typeof envConfig[k] === "object" ? JSON.stringify(envConfig[k]) : envConfig[k];
-  }
-  process.env.CLIENT_ONLY_RENDER = false;
-  process.env.SERVER_SIDE_RENDER = true;
-  if (process.env.BUILD_ENV === "localBuild" && env === "production") {
-    process.env.LOCAL_BUILD_PUBLIC_ASSET_PATH = config.SERVER_PATH + config.LOCAL_ASSET_PATH;
+  if (validateConfigFile(appConfig)) {
+    for (let k in appConfig) {
+      // below code provides support for object handling present in config.
+      // However, for usage on client the client logic in define plugin needs to be checked and updated
+      process.env[k] = typeof appConfig[k] === "object" ? JSON.stringify(appConfig[k]) : appConfig[k];
+    }
   }
 };
 var _default = exports.default = loadEnvironmentVariables;

package/scripts/loadScriptsBeforeServerStarts.js

@@ -4,8 +4,8 @@ var _cssModulesRequireHook = _interopRequireDefault(require("css-modules-require
 var _path = _interopRequireDefault(require("path"));
 var _moduleAlias = _interopRequireDefault(require("module-alias"));
 var _loadEnvironmentVariables = _interopRequireDefault(require("./loadEnvironmentVariables"));
-var _logger = require("../logger");
-var _validator = require("./validator");
+var _logger = require("../logger.js");
+var _validator = require("./validator.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const {
   cssModulesIdentifierDev
@@ -13,41 +13,33 @@ const {
 const {
   _moduleAliases
 } = require(`${process.env.src_path}/package.json`);
-// Add module aliases, but for server aliases (prefix by the `$` symbol), change
-// the directory to match the current build directory (e.g. /dist)
-// This ensures that all alises are properly referencing the babel-built
-// server files
+// stores your config keys in enviorments variables
 (0, _loadEnvironmentVariables.default)();
+
+// creates logger instance with provided config and stores them at global level.
 (0, _logger.configureLogger)({
   enableDebugLogs: process.env.ENABLE_DEBUG_LOGS,
   enableFileLogging: process.env.ENABLE_FILE_LOGGING,
   enableConsoleLogging: process.env.ENABLE_CONSOLE_LOGGING
 });
-process.loadableConfig = {
-  CLIENT_ONLY_RENDER: process.env["CLIENT_ONLY_RENDER"] === "true",
-  SERVER_SIDE_RENDER: process.env["SERVER_SIDE_RENDER"] === "true"
-};
+
+// resolves module alias imports
 if ((0, _validator.validateModuleAlias)(_moduleAliases)) {
   _moduleAlias.default.addAliases(Object.keys(_moduleAliases || []).reduce((resultMap, aliasName) => {
     const aliasPath = _moduleAliases[aliasName];
-    const sym = aliasName[0];
-    if (sym === "$") {
+    if (aliasPath.includes("server")) {
       if (process.env.NODE_ENV !== "production") {
         resultMap[aliasName] = _path.default.join(process.env.src_path, aliasPath);
       } else {
-        resultMap[aliasName] = _path.default.join(process.env.src_path, process.env.OUTPUT_PATH);
+        resultMap[aliasName] = _path.default.join(process.env.src_path, process.env.BUILD_OUTPUT_PATH);
       }
-    } else if (aliasPath.includes("templates")) {
-      resultMap[aliasName] = _path.default.join(process.env.src_path, aliasPath);
-    } else {
-      resultMap[aliasName] = _path.default.join(process.env.src_path, aliasPath);
-    }
+    } else resultMap[aliasName] = _path.default.join(process.env.src_path, aliasPath);
     return resultMap;
   }, {}));
 }
-// import hook before routes
 
-(0, _cssModulesRequireHook.default)({
+// compile css-variables in realtime in dev mode.
+if (process.env.NODE_ENV === "development") (0, _cssModulesRequireHook.default)({
   extensions: [".scss", ".css"],
   generateScopedName: cssModulesIdentifierDev,
   devMode: true,

package/scripts/serve.js

@@ -6,21 +6,28 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 const {
-  spawnSync,
-  execSync
+  spawnSync
 } = require("child_process");
 const path = require("path");
 const {
   name
 } = require(`${process.env.PWD}/package.json`);
+const {
+  BUILD_OUTPUT_PATH
+} = require(`${process.env.PWD}/config/config.json`);
+
+/**
+ * @description -  Serves production build of the application.
+ */
+
 function start() {
-  console.log("Running start....");
   const dirname = path.resolve(__dirname, "../");
   spawnSync("npm", ["run", "serve", `--src_path=${process.env.PWD}`, `--app_name=${name || "catalyst_app"}`], {
     cwd: dirname,
     stdio: "inherit",
     env: _objectSpread(_objectSpread({}, process.env), {}, {
-      src_path: process.env.PWD
+      src_path: process.env.PWD,
+      build_output_path: BUILD_OUTPUT_PATH
     })
   });
 }

package/scripts/start.js

@@ -6,16 +6,14 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 const {
-  spawnSync,
-  execSync
+  spawnSync
 } = require("child_process");
 const path = require("path");
 
 /**
- * @description - starts node and react server.
+ * @description - starts webpack dev server and node server.
  */
 function start() {
-  console.log("Running start....");
   const dirname = path.resolve(__dirname, "../");
   spawnSync("npm", ["run", "start", `--src_path=${process.env.PWD}`], {
     cwd: dirname,

package/scripts/validator.js

@@ -7,7 +7,7 @@ const handleError = e => {
 const validatePreInitServer = fn => {
   try {
     if (!fn) throw new Error("preServerInit named function should be defined in server/index.js");
-    if (typeof fn !== 'function') throw new Error("preServerInit should be function present in server/index.js");
+    if (typeof fn !== "function") throw new Error("preServerInit should be function present in server/index.js");
     return true;
   } catch (e) {
     handleError(e);
@@ -16,7 +16,7 @@ const validatePreInitServer = fn => {
 const validateMiddleware = fn => {
   try {
     if (!fn) throw new Error("addMiddlewares named function not found in server/server.js");
-    if (typeof fn !== 'function') throw new Error("addMiddlewares should be function present in server/server.js");
+    if (typeof fn !== "function") throw new Error("addMiddlewares should be function present in server/server.js");
     return true;
   } catch (e) {
     handleError(e);
@@ -25,7 +25,7 @@ const validateMiddleware = fn => {
 const validateReducerFunction = fn => {
   try {
     if (!fn) throw new Error("reducer not found in src/js/containers/App/reducer");
-    if (typeof fn !== 'function') throw new Error("reducer should present in src/js/containers/App/reducer");
+    if (typeof fn !== "function") throw new Error("reducer should present in src/js/containers/App/reducer");
     return true;
   } catch (e) {
     handleError(e);
@@ -34,7 +34,24 @@ const validateReducerFunction = fn => {
 const validateConfigFile = obj => {
   try {
     if (!obj) throw new Error("config not found in config folder");
-    if (typeof obj !== 'object') throw new Error("config object should be exported from config folder inside your project root directory");
+    if (typeof obj !== "object") throw new Error("config object should be exported from config folder inside your project root directory");
+    if (typeof obj === "object") {
+      const requiredConfigKeys = {
+        NODE_SERVER_HOSTNAME: "",
+        NODE_SERVER_PORT: "",
+        WEBPACK_DEV_SERVER_HOSTNAME: "",
+        WEBPACK_DEV_SERVER_PORT: "",
+        BUILD_OUTPUT_PATH: "",
+        PUBLIC_STATIC_ASSET_PATH: "",
+        PUBLIC_STATIC_ASSET_URL: "",
+        NODE_ENV: "",
+        CLIENT_ENV_VARIABLES: [],
+        ANALYZE_BUNDLE: ""
+      };
+      for (let key in requiredConfigKeys) {
+        if (!(key in obj)) throw new Error(`${key} key not found inside config.json`);
+      }
+    }
     return true;
   } catch (e) {
     handleError(e);
@@ -43,7 +60,7 @@ const validateConfigFile = obj => {
 const validatePackageJson = obj => {
   try {
     if (!obj) throw new Error("package.json not found in the project");
-    if (typeof obj !== 'object') throw new Error("package.json should be defined in project root directory");
+    if (typeof obj !== "object") throw new Error("package.json should be defined in project root directory");
     return true;
   } catch (e) {
     handleError(e);
@@ -52,7 +69,20 @@ const validatePackageJson = obj => {
 const validateModuleAlias = obj => {
   try {
     if (!obj) throw new Error("moduleAliases not found in package.json file present in root directory.");
-    if (typeof obj !== 'object') throw new Error("moduleAliases named object should be exported from package.json");
+    if (typeof obj !== "object") throw new Error("moduleAliases named object should be exported from package.json");
+    if (typeof obj === "object") {
+      const requiredModuleAliases = {
+        "@api": "api.js",
+        "@containers": "src/js/containers",
+        "@server": "server",
+        "@config": "config",
+        "@css": "src/static/css",
+        "@routes": "src/js/routes/"
+      };
+      for (let key in requiredModuleAliases) {
+        if (!(key in obj)) throw new Error(`${key} module alias not defined inside package.json`);
+      }
+    }
     return true;
   } catch (e) {
     handleError(e);
@@ -61,7 +91,7 @@ const validateModuleAlias = obj => {
 const validateConfigureStore = fn => {
   try {
     if (!fn) throw new Error("configureStore not found in file src/js/store/index.js");
-    if (typeof fn !== 'function') throw new Error("configureStore should be function exported from src/js/store/index.js");
+    if (typeof fn !== "function") throw new Error("configureStore should be function exported from src/js/store/index.js");
     return true;
   } catch (e) {
     handleError(e);
@@ -69,8 +99,8 @@ const validateConfigureStore = fn => {
 };
 const validateGetRoutes = fn => {
   try {
-    if (!fn) throw new Error("getRoutes not found in file src/js/routers/index.js");
-    if (typeof fn !== 'function') throw new Error("getRoutes should be function exported from src/js/routers/index.js");
+    if (!fn) throw new Error("getRoutes not found in file src/js/routes/utils.js");
+    if (typeof fn !== "function") throw new Error("getRoutes should be function exported from src/js/routers/index.js");
     return true;
   } catch (e) {
     handleError(e);
@@ -79,7 +109,7 @@ const validateGetRoutes = fn => {
 const validateCustomDocument = fn => {
   try {
     if (!fn) throw new Error("document not found in file server/document.js");
-    if (typeof fn !== 'function') throw new Error("document should be a react component exported from server/document.js");
+    if (typeof fn !== "function") throw new Error("document should be a react component exported from server/document.js");
     return true;
   } catch (e) {
     handleError(e);
@@ -90,7 +120,6 @@ module.exports = {
   validateConfigureStore,
   validateCustomDocument,
   validateGetRoutes,
-  validateModuleAlias,
   validatePackageJson,
   validateReducerFunction,
   validateModuleAlias,