@common-stack/generate-plugin 6.0.6-alpha.5 → 6.0.6-alpha.7

package/lib/generators/add-fullstack/files/docs/development/Mobile/Run_mobile.md

@@ -1,9 +0,0 @@
-
-### How to run mobile?
-
-From the `<root>` of the project, once you finish installation and building all packages, run the following command.
-
-```
-lerna exec --scope=*mobile yarn watch
-```
-

package/src/generators/add-fullstack/files/docs/Moleculer.md

@@ -1,10 +0,0 @@
-
-
-Connecting to moleculer
----
-
-moleculer connect --ns default
-
-
-References:
-https://moleculer.services/docs/0.14/moleculer-cli.html

package/src/generators/add-fullstack/files/docs/References.md

@@ -1,13 +0,0 @@
-
-
-
-Hot Reload in Apollo Server 2
---
-https://github.com/apollographql/apollo-server/issues/1275
-
-
-To update apollo-server
-====
-https://github.com/uzh-bf/klicker-uzh/blob/927512043e8b978c5874bb524eac5c5ff321e28b/apps/backend/src/app.js
-https://github.com/heypoom/eventkit/tree/165eb23dc8f3529b46f2cd1f187e4c592d8c9767
-https://github.com/cerino-ligutom/GraphQL-Starter/blob/master/src/graphql/index.ts

package/src/generators/add-fullstack/files/docs/development/CodeContribution/Adding_New_Modules.md

@@ -1,84 +0,0 @@
-# Adding Modules with FullStack Pro Kit
-
-In this guide, we explain how you can add new modules with FullStack-pro Kit.
-
-## Table of Contents
-
-* [Add New Modules](#installing-and-importing-dependencies)
-
-
-## Add New Modules
-
-Adding new modules, usually goes under `packages-modules` folder. For example to create counter module, you create
-
-1. From root directory, create following folders by running the commands (in unix).
-    ```
-    mkdir -p packages-modules/counter/browser/src
-    mkdir -p packages-modules/counter/servers/src
-
-    touch packages-modules/counter/browser/src/package.json
-    touch packages-modules/counter/servers/src/package.json
-    ```
-
-2. Copy following files from the existing modules,
-
-    From one of the existing moudles, copy the following files into the new module. Make sure the browser's module are copied from another existing browsers location and similarly for server's module.
-
-    - webpack.config.js
-    - tsconfig.json
-
-
-3. Copy the content of the package.json for both browser and server from the existing modules and change the `name` in the package.json to the specific name of the module you want to create. Please make sure to keep the namespace of the module uniform, if the existing module have `@sample-stack`, your new browser module's `package.json` name would be `@sample-stack/counter-browser`, similarly for server module will have `@sample-stack/counter-server`.
-
-    ```json
-    {
-        "name": "@sample-stack/counter-module-browser",
-        "version": "0.0.1",
-        .....
-        "publishConfig": {
-            "access": "public"
-        },
-        .....
-
-        "dependencies": {
-            "@sample-stack/platform-browser": "link:../../../packages/sample-platform/browser",
-        },
-        "peerDependencies": {
-            "@common-stack/client-react": ">=0.0.229",
-            "@common-stack/core": ">=0.0.229",
-            "antd": "^3.26.4"
-        }
-    }
-    ```
-    Add any additional dependencies that this module needed.
-
-4. Then, to use the new module add to `servers` and main `package.json`
-
-    a. In root `package.json` file add the new module where you have existing modules
-    ```json
-    "dependencies": {
-        .....
-        "@sample-stack/counter-module-browser": "link:packages-modules/counter/browser",
-        "@sample-stack/counter-module-server": "link:packages-modules/counter/server",
-        ....
-    }
-    ``` 
-    b. In frontend server `servers/frontend-server` add the browser module with relative path.
-    ```json
-    "dependencies": {
-        .....
-        "@sample-stack/counter-module-browser": "link:../../packages-modules/counter/browser",
-    }
-    ```
-    c. In backend servers `servers/backend-server` add the server module with relative path.
-    ```json
-    "dependencies": {
-        ....
-        "@sample-stack/counter-module-server": "link:../../packages-modules/counter/server",
-        ....
-    }
-    ```
-
-Notes:
-
-- You may have to rerun `yarn watch` to pickup new modules

package/src/generators/add-fullstack/files/docs/development/CodeContribution/Desktop_Setup.md

@@ -1,12 +0,0 @@
-
-# Follow steps to [install project](./Project_Setup.md)
-
-### Start Desktop application
-
-Before to start desktop application, make sure to start the backend server of the web application first. 
-
-`lerna exec --scope=*backend-server yarn watch`
-
-And then start desktop application. 
-
-`lerna exec --scope=*desktop yarn watch`

package/src/generators/add-fullstack/files/docs/development/CodeContribution/DoAndDont.md

@@ -1,35 +0,0 @@
-
-
-
-Don't do it...
----
-1. `yarn <package>`
-
-    Do not install dependencies as `yarn <package dependency>`.
-    We use `lerna` and the way it works for the project is by installing `dependencies` to the `packages` or `servers` that requires it. In most cases,
-    you can just add the package to frontend or backend by running following
-
-    > to add to the frontend server so browser gets it
-
-   `lerna add --scope=*fronted-server <package>`
-
-
-    > to add to the backend server for nodejs to use it
-
-   `lerna add --scope=*backend-server <package>`
-
-    If a dependency is just needed by one package, you can add to that package's package.json file
-
-   `lerna add --scope=<package name> <package>`
-
-   Ideally, root `package.json` should have all the `devDependencies` of the project while `packages` & `servers` file references should be under `dependencies` section as shown [here](https://github.com/cdmbase/fullstack-pro/blob/master/package.json#L67-L78).
-
-   Sometimes we may need to `pin` a package as other dependencies can bring some older versions of the package we want to add. In that case we can pin the required package version by adding to the `pacakge.json`. But make sure you don't have different version of the package in `servers` or `packages` otherwise a duplciate package will be added to its `nodemodules`.
-
-Do
----
-1. Each package version should be uniform across the repository
-
-    Before adding a `<package dependency>`, see if the package of different version exist. If it exist then update that version to the required version.
-
-2. You can edit one of the `packages` or `servers`'s `package.json` file directly to add a `dependencies` and then run `yarn lerna` to install them. This is a easy way to install a known version by adding to the target `pacakage.json` file.

package/src/generators/add-fullstack/files/docs/development/CodeContribution/GitHooks.md

@@ -1,3 +0,0 @@
-### Git Hooks
-
-`Husky` executes `lint-staged` and `commitlint` by git hooks. `lint-staged` makes sure staged files are to be formatted before committed. Refer to `package.json` for details.

package/src/generators/add-fullstack/files/docs/development/CodeContribution/HowToContribute.md

@@ -1,14 +0,0 @@
-
-How to contribute as a developer?
---
-
-1. Once you setup the project, switch to `develop` branch. 
-2. Create a new branch using `develop` branch as source based on the issue you working. 
-3. Update changes to that branch and create a PR agains `develop` branch. 
-4. As soon as PR is created, we have a build process that runs in the background to check whether it is successful or failed.
-5. If it successfull you will see a green check otherwise a red cross. When you notice it has red cross then run `yarn build` locally and fix any issues and submit the commit again to check it's updated status.
-
-
-
-Note: `master` branch is read-only branch and we don't want to merge anything to it other than that from `develop` branch. So please avoid creating PRs agains master branch. 
-

package/src/generators/add-fullstack/files/docs/development/CodeContribution/How_to_Run_Various_Options.md

@@ -1,95 +0,0 @@
-## SETUP and INSTALL
-### To Install the project and build all packages
-
-`yarn bootstrap`
-
-### To clean install the project of already installed.
-
-If you need to do a clean the existing node_modules and take latest changes from the remote head
-
-`yarn clean:install`
-
-## LINTING
-### To check linting
-
-`yarn lint <relative folder>`
-
-### To check and auto fix linting
-
-`yarn format <relative folder>`
-
-## PACKAGES COMMANDS
-### To run build all packages
-
-`yarn build`
-
-### To run all packages in watch mode
-
-`yarn watch`
-
-Note: It only run `packages` and `packages-modules` only in watch mode. Servers should be run seperately.
-
-Also check out `yarn watch-packages` to run watch on required packages. 
-
-### To run build with watch for dependent packages
-
-For auto reloading changes into the server to be productive during development.
-
-```
-yarn watch-packages
-```
-
-If you also need to watch along with it, you can as many scopes as required like below. 
-
-```
-yarn watch-packages -- --scope=@sample-stack/counter-module* --scope=@packageb
-```
-
-## TO START SERVERS
-### To run a individual package in watch mode
-
-`lerna exec --scope=<package name> yarn watch`
-
-More details on how to use [lerna exec](https://github.com/lerna/lerna/tree/master/commands/exec#options)
-
-
-To run any command on a package <package_name>
-
-`lerna exec --scope=<package_name> <command>`
-
-
-### How to Start Backend and Frontend seperately.
-
-To start the frontend-server
-
-`lerna exec --scope=*frontend-server yarn watch`
-
-To just start the backend-server
-
-`lerna exec --scope=*backend-server yarn watch`
-
-### To run both Frontend and Backend Server
-
-`yarn start`
-
-### To run both Frontend and Backend Server but start frontend in SSR Mode
-
-`yarn start:envSSR`
-
-
-### To run Frontend with production build in development
-
-build the package
-
-`lerna exec --scope=*frontend-server yarn build`
-
-start the server with `dev` environment file
-
-`lerna exec --scope=*frontend-server yarn start:dev`
-
-Make sure backend is also running in seperate terminal
-
-`lerna exec --scope=*backend-server yarn watch`
-
-
-

package/src/generators/add-fullstack/files/docs/development/CodeContribution/Known_Issues.md

@@ -1,19 +0,0 @@
-
-
-# Kown Issues
-
-
-1. EACCES: permission denied, scandir .....
-
-Follow the workaround https://github.com/cdmbase/fullstack-pro/issues/176
-
-2. OS X: "Error: EMFILE: too many open files, watch"
-Follow https://github.com/facebook/create-react-app/issues/4540
-
-```
-brew install watchman
-```
-
-3. Macbook Catalina: `Zsh` latest macos comes with `Zsh` as the default shell. We seeing some issues to start the project with it. Please use `bash` to run project.
-
-https://www.howtogeek.com/444596/how-to-change-the-default-shell-to-bash-in-macos-catalina/

package/src/generators/add-fullstack/files/docs/development/CodeContribution/Lint_And_Formatter.md

@@ -1,9 +0,0 @@
-### Lint and Formatter
-
-`eslint` and `prettier` is used along each other. `eslint-config-airbnb-base` (not `eslint-config-airbnb`, which includes `jsx` rules) is used as well. [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest/issues) and [`eslint-plugin-markdown`](https://github.com/eslint/eslint-plugin-markdown) (not for markdown itself, but for code block snippet appeared in markdown) are also configured.
-
-By configuring `overrides` in `.eslintrc.js`, both of typescript and javascript files are able to be linted by `eslint`. (e.g. So typescript rules are not applied to `.js` files.)
-
-[`markdownlint`](https://github.com/DavidAnson/markdownlint) is configured by [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli#readme).
-
-[`commitlint`](https://github.com/conventional-changelog/commitlint) is used as commit message linter. You can `yarn lint:md .`, for example. Refer to [conventional commits](https://www.conventionalcommits.org/en/) for more details.

package/src/generators/add-fullstack/files/docs/development/CodeContribution/Project_Setup.md

@@ -1,159 +0,0 @@
-## Getting Started
-
-If you want to develop FullStack locally you must follow the following instructions:
-
-1. Clone fullstack-pro locally
-```
-git clone https://github.com/cdmbase/fullstack-pro
-cd fullstack-pro
-```
-
-2. Install dependencies and build packages.
-
-    a. make sure `python` version `2.7.16` or higher in `^2` version installed.
-
-    b. install `node-gyp` globally. For installation check [this document](https://github.com/nodejs/node-gyp#installation).
-
-    c. install `watchman` for macOS users
-
-    d. Node version supported is `>=12.18.4` and `yarn` version is `1.22`. You can Download Node from [here](https://nodejs.org/dist/v12.18.4/)
-
-    e. Insall and build packages using following command. Run from the root folder of this project.
-```
-    yarn global add lerna
-    yarn bootstrap
-```
-    
-3. Setup environment file
-
-You need to have environemnt file before you start the project. There is a sample file exist at `config/development/dev.env.sample` which you can copy as `config/development/dev.env`.
-
-```
-cp ./config/development/dev.env.sample ./config/development/dev.env
-```
-
-You may need to set personalized values in the `dev.env` file.
-
-4. Start server MongoDB and Redis (look for Installation Section)
-
-> redis-server
-
-> mongod
-
-5. Start both client and server together
-```
-yarn start
-```
-Alternatively, if you need to run `backend` and `frontend` on its respective terminal instead of one terminal then follow [How to Start Backend and Frontend seperately](./How_to_Run_Various_Options.md#how-to-start-backend-and-frontend-seperately)
-
-### Server Enpoints: 
-The graphql server endpoints are
->http://localhost:8080/graphql
-
-The browser server endopoint is
->http://localhost:3000
-
-
-## How to run with HotReload for live changes both in the server and browser?
-
-To run build with watch for dependent packages, for auto reloading changes into the server to be productive during development.
-
-```
-yarn watch-packages
-```
-
-If you also need to watch along with it, you can use as many scopes as required like below. 
-
-```
-yarn watch-packages -- --scope=@sample-stack/counter-module* --scope=@packageb
-```
-
-To run build with watch for all the packages. Note: This will run watch on all packages under `packages-modules` and may saturate the resources in your laptop instead run above `watch-packages` command.
-
-```
-yarn watch
-```
-
-Sometimes if we have to run `build` or `watch` you can use the `lerna` [command](https://github.com/lerna/lerna/tree/master/commands/exec#usage) for the targeted packages
-
-```
-lerna exec --scope=<package name> yarn watch
-```
-
-- here `<package name>` will be the package you working on currently. If you have multiple packages, then you need to run it multiple times for each package in its respective terminal.
-
-## How to take changes from the branch?
-
-Most of the changes at code level can be taken using `git` command.
-
-But in some cases when `lerna's packages` are added or versions in `packages.json` are updated, to avoid getting installed duplicate pacakges due to monrepo architecture you need to first clean existing `node_modules` and reinstall again. This can be done with following command.
-
-```
-yarn clean:force && git pull <branch_name> && yarn install && yarn build
-```
-- here <branch_name> should be replaced with the branch you getting updates.
-
-## Installation of Prerequisties servers
-
-Install redis and mongo and setup an instance with default settings on default port,
-Please check the installation documentation of each one.
-
-MongoDB install : https://www.mongodb.com/docs/manual/administration/install-community/
-Redis install: https://redis.io/docs/getting-started/
-
-
-## Advance Options
-### To test Production build and run
-You need to run Frontend and Backend in two seperate servers. 
-
-to start frontend server
-```
-lerna exec --scope=*frontend-server yarn build
-lerna exec --scope=*frontend-server yarn start:dev
-```
-to start backend server
-```
-lerna exec --scope=*backend-server yarn build
-lerna exec --scope=*backend-server yarn start:dev
-```
-
-Note: you can pass `:<env>` next to `start` to use env config.
-- dev: to use `/config/development/dev.env`
-- stage: to use `/config/staging/staging.env`
-
-
-
-### Docker build and run
-
-Build three docker images by following the steps:
-- Frontend Server
-```
-lerna exec --scope=*frontend-server yarn docker:build
-lerna exec --scope=*frontend-server yarn docker:run
-```
-- Backend Server
-```
-lerna exec --scope=*backend-server yarn docker:build
-lerna exec --scope=*backend-server yarn docker:run
-```
-- moleculer-server
-```
-lerna exec --scope=*moleculer-server yarn docker:build
-lerna exec --scope=*moleculer-server yarn docker:run
-```
-
-Note: It uses `/config/staging/staging.env` for environment variables.
-
-### Environment settings for non-development
-```
-GRAPHQL_URL
-CLIENT_URL
-NATS_URL
-NATS_USER
-NATS_PW
-```
-## Troubleshoot
-To troubleshoot webpack configuration run
-```
-yarn zen:watch:debug
-```

package/src/generators/add-fullstack/files/docs/development/CodeContribution/React-Patterns/Dynamically_Render_Components.md

@@ -1,57 +0,0 @@
-
-Refernce: https://medium.com/@j5bot/react-dynamically-rendering-different-components-without-switch-the-capitalized-reference-e668d89e460b
-
-```
-import React from 'react'; // required to use JSX
-
-export const CapitalizedReferenceComponentCollectionExternals = (props) => {
-
-  // get references to all possible components
-  // that this component might render,
-  // and the collection of dynamic components we need to render,
-  // using destructuring
-  const { components: Components, collection } = props;
-
-  // A Capitalized reference to reuse
-  let Component;
-
-  // A reference to the component's props to reuse
-  let componentProps;
-
-  // A function which returns component.props if it exists,
-  // and otherwise returns props
-  const defaultMapPropsToComponent = function (
-    {
-      component = {},
-      props = {}
-    } = {}
-  ) {
-
-    return component.props || props;
-
-  };
-
-  // render the component collection
-  return(
-    <div>{
-        collection.map(
-          ( component ) => {
-            // Reference the proper component
-            Component = Components[ component.type ];
-            // Get the props you want to use for this component instance
-            // here we are assuming that you can specify a mapping function
-            // on the component definition, in props, or use the default
-            componentProps = (
-              component.mapPropsToComponent ||
-                props.mapPropsToComponent ||
-                  defaultMapPropsToComponent
-            )( component, props );
-            return (<Component { ...componentProps } />);
-          }
-        )
-    }</div>
-  );
-};
-
-export default CapitalizedReferenceComponentCollectionExternals;
-```

package/src/generators/add-fullstack/files/docs/development/CodeContribution/React-Patterns/HOC_With_Render_Props.md

@@ -1,87 +0,0 @@
-Reference: https://gist.github.com/mjackson/a1bee5a8b24a0db7ff29586b124cfb38
-https://www.youtube.com/watch?v=BcVAq3YFiuc&t=1397s
-https://cdb.reacttraining.com/use-a-render-prop-50de598f11ce
-```
-import React from "react";
-import ReactDOM from "react-dom";
-import PropTypes from "prop-types";
-
-document.body.style.background = `
-  linear-gradient(135deg,
-    #1e5799 0%,
-    #2989d8 50%,
-    #207cca 51%,
-    #7db9e8 100%
-  )
-`;
-
-const getHeaderStyle = y => {
-  const pin = y >= 100;
-  const top = -y / 2;
-  return {
-    textTransform: "uppercase",
-    textAlign: "center",
-    width: "100%",
-    margin: 0,
-    position: "fixed",
-    top: pin ? "0px" : `${top + 50}px`,
-    textShadow: pin
-      ? `0px ${(y - 100) / 5}px ${Math.min(
-          (y - 100) / 10,
-          20
-        )}px rgba(0, 0, 0, 0.5)`
-      : "none"
-  };
-};
-
-class ScrollY extends React.Component {
-  state = { y: 0 };
-
-  handleWindowScroll = () => {
-    this.setState({ y: window.scrollY });
-  };
-
-  componentDidMount() {
-    this.handleWindowScroll();
-    window.addEventListener("scroll", this.handleWindowScroll);
-  }
-
-  componentWillUnmount() {
-    window.removeEventListener("scroll", this.handleWindowScroll);
-  }
-
-  render() {
-    return this.props.children(this.state.y);
-  }
-}
-
-class App extends React.Component {
-  render() {
-    const { y } = this.props;
-
-    return (
-      <div style={{ height: "300vh", color: "white" }}>
-        <h1 style={getHeaderStyle(y)}>{this.props.message}</h1>
-      </div>
-    );
-  }
-}
-
-function withScrollY(Component) {
-  return class extends React.Component {
-    render() {
-      return (
-        <ScrollY>{y => <Component {...this.props} y={y} />}</ScrollY>
-      );
-    }
-  };
-}
-
-const AppWithScrollY = withScrollY(App);
-
-ReactDOM.render(
-  <AppWithScrollY message="hello" />,
-  document.getElementById("app")
-);
-
-```

package/src/generators/add-fullstack/files/docs/development/CodeContribution/React-Patterns/Mongoose_Connection.md

@@ -1,45 +0,0 @@
-
-Reference:
-https://github.com/barakbd/docker_typescript_debug_vscode/blob/8454ab4bdd9713da373e898e7c606193bfbfc5e2/src/config/mongoose_connection.ts
-
-```
-/ https://codingsans.com/blog/mongoose-models-using-typescript-classes
-import * as mongoose from "mongoose";
-var connectionOptions: mongoose.ConnectionOptions | undefined;
-
-const uri: string = `mongodb://${process.env.MONGODB_HOST_AND_PORT_LIST}/${
-  process.env.MONGODB_DATABASE_NAME
-}`;
-
-console.log("uri", uri);
-const mongooseConnectionOptions: mongoose.ConnectionOptions = {
-  autoReconnect: true,
-  reconnectTries: 3,
-  keepAlive: 120,
-  user: process.env.MONGODB_DB_USERNAME,
-  pass: process.env.MONGODB_DB_PASSWORD,
-  authSource: process.env.MONGODB_AUTH_SOURCE,
-  replicaSet: process.env.MONGODB_REPLICASET
-};
-
-process.env.NODE_ENV === "local"
-  ? (connectionOptions = undefined)
-  : (connectionOptions = mongooseConnectionOptions);
-
-console.log("mongoose connectionOptions - ", connectionOptions);
-
-mongoose
-  .connect(uri, connectionOptions)
-  .then(() => {
-    console.info("mogoose connect - success");
-    // console.info(`uri - ${uri}`);
-    // console.info(`connectionOptions - ${connectionOptions}`);
-  })
-  .catch((err: mongoose.Error) => {
-    console.error("mogoose connect - error - ", err);
-    // throw err;
-    process.kill(process.pid);
-  });
-const mongooseConnection: mongoose.Connection = mongoose.connection;
-export { mongooseConnection };
-```

package/src/generators/add-fullstack/files/docs/development/CodeContribution/React-Patterns/React_Componet_Extensions.md

@@ -1,11 +0,0 @@
-
-
-https://github.com/superdesk/superdesk-client-core/blob/d5ee7b11dddd2255a77b518e177b7ec33b167311/scripts/apps/extension-points/services/ExtensionPoints.js
-
-https://github.com/taskrabbit/react-component-extension
-
-
-
-https://github.com/camwest/react-slot-fill
-
-Reference: https://www.youtube.com/watch?v=395ou6k6C6k

package/src/generators/add-fullstack/files/docs/development/CodeContribution/React-Patterns/RxJS_notes.md

@@ -1,3 +0,0 @@
-
-
-https://itnext.io/handling-redux-side-effects-the-rxjs-way-59c057b12cd4