@epilot360/create-mfe-app

Dev CLI for generating Epilot360 MFE projects

Usage no npm install needed!

<script type="module">
  import epilot360CreateMfeApp from 'https://cdn.skypack.dev/@epilot360/create-mfe-app';
</script>

README

@epilot360/create-mfe-app

Create Epilot360 Portal Microfrontend apps with complete deployment setup.

Create Epilot360 App works on macOS, Windows, and Linux.

Quick Overview

You can create Epilot360 MFE either of the following ways,

Global Installation

npm install -g @epilot360/create-mfe-app

Then to create new MFE application just run create-epilot360-app the terminal,

Step 1:

Enter the directory path or name for the project, by default it is . , eg. epilot360-topbar

? Directory for new project: epilot360-topbar

Step 2:

Choose the type of Epilot360 App you wanted to create, singleSpa-react-app / parcel or in-browser utility module

? Select type to generate for epilot360 portal (Use arrow keys)
❯ single-spa application / parcel 
  in-browser utility module (styleguide, api cache, etc) 

Step 3:

Name for your MFE project, you can just type the name simply as topbar, so with this app package name will be prefixed with @epilot360 and final name would be @epilot360/topbar to register in the root config.

? Project name (can use letters, numbers, dash or underscore): topbar

Step 4:

Boom, that's it.🚀 Your project is ready. All the dependencies will be installed automatically. All MFE projects uses yarn for managing packages.

✨  Done in 66.16s.
Project setup complete!
Steps to test your React Epilot 360 application:
1. cd <project-name>
1. Run 'yarn start'
2. Go to 'epilot360-root-confg' and integrate '@epilot360/topbar' to see it working!

Using npx

Alternatively you can also use npx @epilot360/create-mfe-app to create MFE projects as it always uses the latest version.