modular-scripts
v5.1.1
Published
<div align="center"> <h1><img height="38px" width="44px" style="height: 38px; max-width: 44px" src="https://raw.githubusercontent.com/jpmorganchase/modular/main/docs/img/modular-hero.svg"> Modular</h1>
Downloads
38
Keywords
Readme
modular
is a collection of tools and guidance to enable micro-frontend
development at scale. It is derived from work at JP Morgan to enable development
in large monorepositories owned by many teams.
It provides a CLI to:
- Scaffold new micro-frontends and libraries from scratch
- Provide ready-to-use, opinionated test, lint and build configurations for micro-frontends and libraries
- Provide tooling to incrementally and selectively run operations on monorepositories at scale
Pre-requisites
See the compatibility page.
Getting Started
yarn create modular-react-app my-new-modular-project [--verbose] [--prefer-offline] [--repo]
Bootstraps a new project, configured to use Yarn workspaces.
This also creates a workspace named 'app' which is a new modular app written in TypeScript.
It supports three flags:
--verbose
enables verboseyarn
andmodular
logging.--prefer-offline
will prefer locally cachednode_modules
versions over those from your remote registry.--repo <value>
will toggle whether a newgit
repo is created and the initial files committed.
Commands
More documentation about modular commands is here.
Configuration
Modular is based around the idea of minimal configuration - however documentation for the options available is here.