https://github.com/waldronmatt/module-federation-boilerplate

A dynamic, multi-environment module federation boilerplate.
https://github.com/waldronmatt/module-federation-boilerplate

boilerplate commitizen commitlint configuration dynamic host husky lerna lint-staged microservice module-federation remote template turbo turborepo yarn-workspaces

Last synced: 3 months ago
JSON representation

A dynamic, multi-environment module federation boilerplate.

• Host: GitHub
• URL: https://github.com/waldronmatt/module-federation-boilerplate
• Owner: waldronmatt
• License: mit
• Created: 2022-04-14T00:45:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-12T19:20:27.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T02:48:43.762Z (almost 2 years ago)
• Topics: boilerplate, commitizen, commitlint, configuration, dynamic, host, husky, lerna, lint-staged, microservice, module-federation, remote, template, turbo, turborepo, yarn-workspaces
• Language: JavaScript
• Homepage: https://module-federation-boilerplate-host.netlify.app/
• Size: 3.05 MB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Module Federation Boilerplate

**[Host App](https://module-federation-boilerplate-host.netlify.app)**

[![Host App Netlify Status](https://api.netlify.com/api/v1/badges/dd3fd5c7-0168-4cd7-a56a-673503681f86/deploy-status)](https://app.netlify.com/sites/module-federation-boilerplate-host/deploys)

**[Remote App](https://module-federation-boilerplate-remote.netlify.app)**

[![Remote App Netlify Status](https://api.netlify.com/api/v1/badges/5ba4ad1f-811d-493f-8030-92e9ba296a43/deploy-status)](https://app.netlify.com/sites/module-federation-boilerplate-remote/deploys)

A dynamic, multi-environment module federation boilerplate.

## Features

- Multi-environment support using `NormalModuleReplacementPlugin`

- Loads remote apps dynamically

- Uses my [shareable configs](https://github.com/waldronmatt/shareable-configs) to reduce boilerplate

- ~100% Lighthouse Score

## Installation

Install package dependencies and link local packages together:

```bash

yarn

```

Install hooks:

```bash

yarn prepare

```

## Getting Started

Run dev environment for host and remote:

```bash

yarn dev

```

Build and serve host and remote for Netlify:

```bash

yarn build

```

**Note:** Configure script in Netlify to auto-run via push to `main` branch.

Build host and remote for Express:

```bash

yarn prod

```

Serve host and remote for Express:

```bash

yarn serve

```

## Commands

Commit changes using conventional changelog:

```bash

yarn commit

```

Lint host and remote files:

```bash

yarn lint

```

**Note**: `release.yml` will run this before versioning and publishing.

## License

MIT