Templates

Are you going to create a new Micro Frontend?

The Orchy Project provides different templates which works out-of-the-box with the orchestrator: you only have to choose your preferred one, clone it and start editing!

Here an exhaustive list of all the available templates grouped by type.

Template	Variants
React	JavaScript	TypeScript
Angular	TypeScript
Vue	JavaScript	TypeScript
Svelte	JavaScript	TypeScript
Preact	JavaScript	TypeScript
Solid	JavaScript	TypeScript
Vanilla	JavaScript	TypeScript

info

All the templates includes unit tests to ensure that they always work correctly.

Additionally, the dependencies of each template are automatically updated using Renovate.

Interactive template download

Would you like to scaffold a new Micro Frontend, without leaving the CLI?

The tool create-orchy-mfe is what you need!

Usage

There are multiple ways to run it, e.g.:

• installing it, using the command

npm install -g create-orchy-mfe

• using npx, with the command

npx create-orchy-mfe

• using npm, with the command

npm create orchy-mfe

The following video is an example of what you can get with create-orchy-mfe installed and running.

Non-interactive template download

If you prefer, create-orchy-mfe can also be invoked in a non-interactive way, using the following CLI arguments:

Options:
    -d, --directory  The directory where your micro-frontend will be located
    -h, --help       Output usage information
    -n, --name       The name of your new micro-frontend
    -t, --template   The template that will be used generate your micro-frontend
    -T, --ts         Use the TypeScript variant of the template
    -v, --version    Output the version number

Troubleshooting

Rate limit

If you get an error about GitHub's rate limit, you should define the GITHUB_AUTH_TOKEN environment variable, which will be used to access the GitHub APIs' using the octokit client.