README.md

November 8, 2022 · View on GitHub

♨️ React Module Federation Boilerplate

A React boilerplate with opinionated setup to help you quickly kickstart projects with module federation.

MIT license

The Setup

React v18
React Router v6
TypeScript
Linting with Eslint and code formatting with Prettier
Conventional commit messages with Commitlint
Monorepo codebase management with Nx

Get Started

Use Boilertowns CLI.

# npm
npm create boilertowns@latest -- -b react-module-federation-boilerplate

# yarn
yarn create boilertowns -b react-module-federation-boilerplate

# pnpm
pnpm create boilertowns -b react-module-federation-boilerplate

# bun
bun create boilertowns/react-module-federation-boilerplate [project-name]

Click the green "Use this template" button to generate a new repository with the same structure and files.

Ref: Github Docs

Development

Run all projects in apps/* folder in development environment:
```
pnpm dev
```
Build all projects in apps/* for to deploy:
```
pnpm build
```

Contributing

react-module-federation-boilerplate ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.