Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • C create-react-app
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,547
    • Issues 1,547
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 417
    • Merge requests 417
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Meta
  • create-react-app
  • Merge requests
  • !11729

Add support for new ENTRY_PATH and PUBLIC_PATH advanced configuration variables

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/dblazheski96/entry-path-variable into main Dec 08, 2021
  • Overview 9
  • Commits 2
  • Pipelines 0
  • Changes 2

Created by: dblazheski96

Summary

Add support for a new environment variables, ENTRY_PATH and PUBLIC_PATH, which may be used to override the default entry point src/index and the default public path public. It opens new possiblities for developing mini-apps within a container app without actually doing eject, hence almost config-less micro-frontend architecure.

Configuring PUBLIC_PATH will also update the index.html path respectively

Benefits

  • The default behaviour is persisted.
  • Can be configuired for a different entry point if you like it.
  • Can be configuired for a different public path if you like it.
  • Not doing eject for just a couple of paths (keeping the package.json clean)

If developing mini-apps are in mind

  • Shared resources, all in one container app (configurations, rule-sets and even components)
  • Great overview of the whole project
  • Can be used in CI/CD build piplines
  • Again not doing eject

Examples

  • Multiple build and start scripts for each mini-app

    ENTRY_PATH configured for each mini-app

    {
      "scripts": {
        "start": "ENTRY_PATH=src/customer/index react-scripts start",
        "start:business": "ENTRY_PATH=src/business/index react-scripts start",
        "start:admin": "ENTRY_PATH=src/admin/index react-scripts start",
      },
    }

    ENTRY_PATH can be used in conjunction with BUILD_PATH for a nicer output structure

    {
      "scripts": {
        "build": "ENTRY_PATH=src/customer/index BUILD_PATH=build/customer react-scripts build",
        "build:business": "ENTRY_PATH=src/business/index BUILD_PATH=build/business react-scripts build",
        "build:admin": "ENTRY_PATH=src/admin/index BUILD_PATH=build/admin react-scripts build",
      }
    }

    PUBLIC_PATH used in conjunction with ENTRY_PATH and BUILD_PATH

    {
      "scripts": {
        "build": "ENTRY_PATH=src/customer/index PUBLIC_PATH=public/customer BUILD_PATH=build/customer react-scripts build",
        "build:business": "ENTRY_PATH=src/business/index PUBLIC_PATH=public/business BUILD_PATH=build/business react-scripts build",
        "build:admin": "ENTRY_PATH=src/admin/index PUBLIC_PATH=public/admin BUILD_PATH=build/admin react-scripts build",
      }
    }
  • Github Workflow

    on:
      push:
        branches:
          - main
        paths-ignore:
          - 'src/customer/**'
          - 'src/admin/**'
    
    <!-- rest of configuration -->
    
    env:
      ENTRY_PATH: src/business/index
      PUBLIC_PATH: public/business
      BUILD_PATH: build/business

    For this workflow example, only the default build script in package.json is necessary, others can be used for development purposes.

    {
      "scripts": {
        "build": "react-scripts build",
        "build:customer": "ENTRY_PATH=src/customer/index PUBLIC_PATH=public/customer BUILD_PATH=build/customer react-scripts build",
        "build:business": "ENTRY_PATH=src/business/index PUBLIC_PATH=public/business BUILD_PATH=build/business react-scripts build",
        "build:admin": "ENTRY_PATH=src/admin/index PUBLIC_PATH=public/admin BUILD_PATH=build/admin react-scripts build",
      }
    }
  • Folder structure

folder-structure

public-assets

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/dblazheski96/entry-path-variable