https://github.com/jpmorganchase/modular

A modular front end development framework
https://github.com/jpmorganchase/modular

esbuild jpmorgan modular react

Last synced: 7 days ago
JSON representation

A modular front end development framework

• Host: GitHub
• URL: https://github.com/jpmorganchase/modular
• Owner: jpmorganchase
• License: apache-2.0
• Created: 2020-05-21T15:44:43.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-05T18:54:55.000Z (6 months ago)
• Last Synced: 2024-10-02T18:46:54.619Z (about 1 month ago)
• Topics: esbuild, jpmorgan, modular, react
• Language: TypeScript
• Homepage: https://modular.js.org/
• Size: 15.8 MB
• Stars: 618
• Watchers: 16
• Forks: 67
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


   Modular


  
Scaled Web Engineering. Where libraries and micro-frontends coexist together and tooling is a first-class citizen.



---

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?)](https://github.com/jpmorganchase/modular/blob/main/CONTRIBUTING.md)

[![NPM version](https://img.shields.io/npm/v/modular-scripts.svg)](https://www.npmjs.com/package/modular-scripts)

![Static](https://github.com/jpmorganchase/modular/actions/workflows/static.yml/badge.svg)

![Tests](https://github.com/jpmorganchase/modular/actions/workflows/test.yml/badge.svg)

[![Coverage](https://coveralls.io/repos/github/jpmorganchase/modular/badge.svg?branch=main)](https://coveralls.io/github/jpmorganchase/modular?branch=main)

`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](https://modular.js.org/compatibility/).

## Getting Started

```bash

  yarn create modular-react-app my-new-modular-project [--verbose] [--prefer-offline] [--repo]

```

Bootstraps a new project, configured to use

[Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).

This also creates a workspace named 'app' which is a new

[modular app](./package-types) written in

[TypeScript](https://www.typescriptlang.org/).

It supports three flags:

- `--verbose` enables verbose `yarn` and `modular` logging.

- `--prefer-offline` will prefer locally cached `node_modules` versions over

  those from your remote registry.

- `--repo ` will toggle whether a new `git` repo is created and the

  initial files committed.

## Commands

More documentation about modular commands is

[here](https://modular.js.org/commands/).

## Configuration

Modular is based around the idea of minimal configuration - however

documentation for the options available is

[here](https://modular.js.org/configuration/).