@snapify/shared-modules v1.8.4

React Micro Frontend Utility Template

Getting Started

1. Run the script to initialize the project and install dependencies:

./setup.sh

2. Run yarn start --port ${YOUR_PORT} to run locally

3. Add your new micro frontend at the root config module inside

<script type="systemjs-importmap">
  {
    "imports": {
      "react": "https://cdn.jsdelivr.net/npm/react@16.13.0/umd/react.production.min.js",
      "react-dom": "https://cdn.jsdelivr.net/npm/react-dom@16.13.0/umd/react-dom.production.min.js",
      "single-spa": "https://cdn.jsdelivr.net/npm/single-spa@5.3.0/lib/system/single-spa.min.js",
      "@${PROJECT_NAME}/root-config": "//localhost:9000/${PROJECT_NAME}-root-config.js",
      "@${PROJECT_NAME}/{UTILITY_MODULE_NAME}": "//localhost:${YOUR_PORT}/${PROJECT_NAME}-{UTILITY_MODULE_NAME}.js"
    }
  }
</script>

4. Register your utility module as external at webpack.config.js for each micro frontend

const { merge } = require('webpack-merge');
const singleSpaDefaults = require('webpack-config-single-spa-react-ts');

module.exports = (webpackConfigEnv, argv) => {
  const defaultConfig = singleSpaDefaults({
    orgName: '${PROJECT_NAME}',
    projectName: '${MICRO_FRONTEND_NAME}',
    webpackConfigEnv,
    argv,
  });

  return merge(defaultConfig, {
    // change the placeholders
    externals: ['${PROJECT_NAME}/{UTILITY_MODULE_NAME}'],
  });
};

5. Import your utilities at the micro frontend and use them

import { utilityName } from '@${PROJECT_NAME}/{UTILITY_MODULE_NAME}';

6. If you are using TypeScript at your micro frontend, it's recommended to use NPM when running ./setup.sh and then run yarn add @${PROJECT_NAME}/{UTILITY_MODULE_NAME}

This way, TypeScript will infer your types and code. Also, Jest won't fail when testing and not detecting a valid import of the utility

7. Run yarn start to run your root config module

Important notes

• Maintain consistency for the project name (all micro service and root project should have the same project name)

• It's recommended to use the root config module template from this template to be consistent with project naming convention

• To setup environment variables, change the start script at package.json and use the --env flag

webpack serve --env isLocal

• Set ACTIONS_DEPLOY_ACCESS_TOKEN secret at your repository with a GitHub Personal Access Token so that Semantic Release can work properly

  • This token should have full control of private repositories

• Set NPM_TOKEN secret at your repository with an NPM Automation Access Token so that your utility can be deployed to NPM

It's highly recommended to publish your package to NPM so that you don't have TypeScript errors about not finding your utility module when it is imported at your micro frontends.

• Your ${PROJECT_NAME} prompted when running ´./setup.sh´ should be the same as your organization or username from NPM. This way, you will avoid errors when executing your GitHub actions pipeline at ´npm publish --access=public´ step

You can remove ´--access=public´ option from ´npm publish´ if you can publish private packages to NPM

• You can remove the ´.github´ folder if you don't want to use CI / CD GitHub actions for semantic release, publish to NPM, automated testing and deployment.

• Build the project with yarn build and deploy the files to a CDN or host to serve those static files.

• This project uses AWS S3 to host the build files. In order to use this feature properly:

  • Create an IAM user with S3 permissions and setup AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY at repository secrets
  • Type your bucket name when executing setup.sh
  • Create an S3 bucket at AWS and change bucket settings according to your needs
    • Uncheck all options at bucket settings or just whatever is necessary
    • Change bucket policy allowing externals to get your objects

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Principal": "*",
          "Action": "s3:GetObject",
          "Resource": "arn:aws:s3:::YOUR-BUCKET-NAME/*"
        }
      ]
    }

    • Add CORS setting so that your root module can fetch your bucket files from local dev machine or production and dev servers

    [
      {
          "AllowedHeaders": [
              "Authorization"
          ],
          "AllowedMethods": [
              "GET",
              "HEAD"
          ],
          "AllowedOrigins": [
              "http://localhost:3000",
              "http://{WEB_SERVER_DOMAIN_1}",
              "https://{WEB_SERVER_DOMAIN_2}",
          ],
          "ExposeHeaders": [
              "Access-Control-Allow-Origin"
          ]
      }
    ]

    • Finally, add your compiled JS utility code at the root module import maps

    <% if (isLocal) { %>
    <script type="systemjs-importmap">
      {
        "imports": {
          "@${PROJECT_NAME}/root-config": "//localhost:9000/${PROJECT_NAME}-root-config.js",
          "@${PROJECT_NAME}/{UTILITY_MODULE_NAME}": "//localhost:${YOUR_PORT}/${PROJECT_NAME}-{UTILITY_MODULE_NAME}.js"
        }
      }
    </script>
    <% } else { %>
    <script type="systemjs-importmap">
      {
        "imports": {
          "@${PROJECT_NAME}/root-config": "https://{S3_BUCKET_NAME}.s3.amazonaws.com/${PROJECT_NAME}-root-config.js",
          "@${PROJECT_NAME}/{UTILITY_MODULE_NAME}": "https://{S3_BUCKET_NAME}.s3.amazonaws.com/${PROJECT_NAME}-{UTILITY_MODULE_NAME}.js"
        }
      }
    </script>
    <% } %>