create-catalyst-app-internal 0.0.1-beta.12 → 0.0.1-beta.14

package/Readme.md

@@ -0,0 +1,52 @@
+# Creating a Catalyst App
+
+Scaffold  your Catalyst app  swiftly with `create-catalyst-app`. This tool expedites the process by initializing your project with predefined configurations. To kickstart your project, execute the following command:
+
+```bash
+npx create-catalyst-app@latest
+```
+
+Upon execution, you'll be prompted to name your project. Once named, a template will be cloned into the specified directory.
+
+```bash
+✔ What is your project named? my-app
+```
+
+Next, select your preferred state management tool from the provided options.
+
+```bash
+? Choose state management: › - Use arrow-keys. Return to submit .
+❯   Redux
+    Redux Toolkit (RTK)
+    None
+```
+
+Following your selection, a default template will be cloned into the directory, and all necessary packages will be installed.
+
+## Getting Started
+Commence development by initiating the application in development mode with the following commands:
+
+Navigate into the directory
+
+```bash
+cd my-app
+```
+For running the application in development mode, run:
+```bash
+npm run start
+```
+
+For a production build, change NODE_ENV to "production" in config/config.json, and then run :
+
+```bash
+npm run build
+```
+
+To serve the production build, execute:
+
+```bash
+npm run serve
+```
+
+## Documentation
+Explore the complete documentation at [https://catalyst.1mg.com](https://catalyst.1mg.com).

package/license

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 1mg Healthcare Solutions Private Limited.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+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.
+

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "create-catalyst-app-internal",
     "bin": "scripts/cli.cjs",
-    "version": "0.0.1-beta.12",
+    "version": "0.0.1-beta.14",
     "description": "cli package to scaffold Catalyst application",
     "main": "index.js",
     "scripts": {

package/templates/common/README.md

@@ -1,6 +1,6 @@
 ## Getting Started
 
-Commence development by initiating the application in development mode with the following commands:
+Commence development by initiating the  the following commands:
 
 For running the application in development mode, run:
 
@@ -8,7 +8,7 @@ For running the application in development mode, run:
 npm run start
 ```
 
-For a production build, utilize:
+For a production build, change NODE_ENV to "production" in config/config.json, then run :
 
 ```bash
 npm run build

package/templates/common/api.js

@@ -3,16 +3,16 @@ const apiInstance = () => {
         let baseURL = process.env.API_URL
         let finalUrl = baseURL + url
 
-        // Request Interceptor - you can modify request here
+        // Request Interceptor -  modify request here
 
-        // Add query params if exist
+        // Add query params
         if (Object.keys(options?.params).length > 0) {
             finalUrl = url + "?" + new URLSearchParams(options.params)
         }
 
         return fetch(finalUrl, options).then(async (response) => {
             const parsedResponse = await response.json()
-            // Response Interceptor - you can modify response here
+            // Response Interceptor -  modify response here
             return parsedResponse
         })
     }

package/templates/common/client/styles.js

@@ -1,14 +1,3 @@
-/* Style Loader
- *
- * Anything imported in here will either be added to the vendor CSS chunk, or
- * the main app CSS chunk. Where they will go depends on its location or its
- * extension.
- *
- * Files will be added to the vendor.css chunk if:
- * - they are located inside `node_modules`, or
- * - they are plain .css files.
- * Otherwise, files will be added to the main app.css chunk.
- */
+// Include initial base styles. Global styles will come here.
 
-// Include initial base styles.
 import "@css/base/index.scss"

package/templates/common/config/config.json

@@ -10,23 +10,6 @@
     "API_URL": "",
     "ANALYZE_BUNDLE": false,
     "CLIENT_ENV_VARIABLES": [
-        "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",
-        "BUILD_ENV",
-        "API_URL",
-        "ANALYZE_BUNDLE",
-        "ENABLE_DEBUG_LOGS",
-        "ENABLE_FILE_LOGGING",
-        "ENABLE_CONSOLE_LOGGING",
-        "ANALYZE_BUNDLE",
-        "ENABLE_DEBUG_LOGS",
-        "ENABLE_FILE_LOGGING",
-        "ENABLE_CONSOLE_LOGGING"
+        "API_URL"
     ]
 }

package/templates/common/server/index.js

@@ -1 +1,2 @@
+// This function is executed before server starts.
 export const preServerInit = () => {}

package/templates/common/server/server.js

@@ -1,8 +1,8 @@
-const express = require('express');
-const path = require('path');
+const express = require("express")
+const path = require("path")
 
-export function addMiddlewares(app) {
-
-    app.use('/favicon.ico', express.static(path.join(__dirname, '../public/favicon.ico')));
+// Server middlewares are added here.
 
+export function addMiddlewares(app) {
+    app.use("/favicon.ico", express.static(path.join(__dirname, "../public/favicon.ico")))
 }

package/templates/none-js/package.json

@@ -17,6 +17,6 @@
     "dependencies": {
         "@loadable/component": "^5.16.3",
         "@tata1mg/router": "^0.0.1-beta.0",
-        "catalyst-core-internal": "^0.0.1-beta.6"
+        "catalyst-core-internal": "^0.0.1-beta.7"
     }
 }

package/templates/none-js/src/js/routes/utils.js

@@ -0,0 +1,28 @@
+import React from "react"
+import { RouterDataProvider, MetaTag } from "@tata1mg/router"
+import App from "@containers/App"
+import routes from "./index.js"
+
+export const preparedRoutes = ({ routerInitialState }) => {
+    return [
+        {
+            element: (
+                <RouterDataProvider config={{}} initialState={routerInitialState}>
+                    <MetaTag />
+                    <App />
+                </RouterDataProvider>
+            ),
+            children: getRoutes()?.map((route, index) => {
+                const Component = route.component
+                return {
+                    ...route,
+                    element: <Component key={index} />,
+                }
+            }),
+        },
+    ]
+}
+
+export const getRoutes = () => {
+    return routes
+}

package/templates/redux-js/package.json

@@ -18,7 +18,7 @@
     "dependencies": {
         "@loadable/component": "^5.16.3",
         "@tata1mg/router": "^0.0.1-beta.0",
-        "catalyst-core-internal": "^0.0.1-beta.6",
+        "catalyst-core-internal": "^0.0.1-beta.7",
         "@reduxjs/toolkit": "1.9.3",
         "react-redux": "^8.1.3"
     }

package/templates/rtk-js/package.json

@@ -18,7 +18,7 @@
     "dependencies": {
         "@loadable/component": "^5.16.3",
         "@tata1mg/router": "^0.0.1-beta.0",
-        "catalyst-core-internal": "^0.0.1-beta.6",
+        "catalyst-core-internal": "^0.0.1-beta.7",
         "@reduxjs/toolkit": "1.9.3",
         "react-redux": "^8.1.3"
     }

package/templates/rtk-js/src/js/routes/utils.js

@@ -0,0 +1,28 @@
+import React from "react"
+import { RouterDataProvider, MetaTag } from "@tata1mg/router"
+import App from "@containers/App"
+import routes from "./index.js"
+
+export const preparedRoutes = ({ store, routerInitialState }) => {
+    return [
+        {
+            element: (
+                <RouterDataProvider config={{}} initialState={routerInitialState} fetcherArgs={{ store }}>
+                    <MetaTag />
+                    <App />
+                </RouterDataProvider>
+            ),
+            children: getRoutes()?.map((route, index) => {
+                const Component = route.component
+                return {
+                    ...route,
+                    element: <Component key={index} />,
+                }
+            }),
+        },
+    ]
+}
+
+export const getRoutes = () => {
+    return routes
+}