Skip to content

Commit

Permalink
Updated Documentation for Intro & Why and How
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinod Kumar authored and Vinod Kumar committed May 30, 2022
1 parent b6ee947 commit ad3ac46
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
28 changes: 14 additions & 14 deletions docs/how.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,30 @@ title: How it works?

There are 2 Key Pillars of Universal React.

## 1. Accelerate React Development by instant initial setup
## 1. Instant initial setup

React developers can run `npx create-universal-react` generator for setting up Micro Frontend and SPA architecture with essential tooling instantly.
## 2. Continuous Improvement and Support via addition of optional features
React developers can run `npx create-universal-react` generator for setting up Micro Frontend and/or SPA architecture with essential tooling instantly.
## 2. On-demand addition of optional features

React developers can run `npx create-universal-react` generator again for adding on-demand optional features and projects to evolving applications generated with Universal React.
React developers can continuously improve their project by running `npx create-universal-react` generator again for adding optional features like mocking, end-to-end testing or even new projects to their evolving applications.

## Execution flow of generator

Following flow chart explains the workings of generator.

![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)

## Possible Architecture Overview
## Architecture Overview

Using this generator flow you can setup and evolve a project into following Architecture types.
Using this generator you can setup and evolve a project into a combination of following architecture types.

![Architecture Types with Universal React generator](/img/universal-react-arch-types-2x.png)

### How does Universal React achieve Micro Frontend?

There are 2 ways you can achieve Micro Frontend in this ecosystem.

1. Micro-App Loader: A small NPM package to load any React micro app or Web Component into a given container. This approach is ideal when:
1. **Micro-App Loader**: A small NPM package to load any React micro app or Web Component into a given container. This approach is ideal when:
1. You are not loading too many Micro Apps on a page.
2. You don't want to change configurations of Micro App to support Module Federation.
2. Module Federation: Multiple separate builds should form a single application. These separate builds should not have dependencies between each other, so they can be developed and deployed individually. Learn more [here](/universal-react-docs/docs/module-federation/).
2. **Module Federation**: Multiple separate builds should form a single application. These separate builds should not have dependencies between each other, so they can be developed and deployed individually. Learn more [here](/universal-react-docs/docs/module-federation/).

## Execution flow of generator

Following flow chart explains the workings of generator.

![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)
1 change: 1 addition & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This will run the universal-react CLI, then you can simply interact with command
3. Turborepo

### Uses Prerequisites

1. Node >= 14.17.6
2. NPM >= 7.0.0
3. Python Latest Version
Expand Down
2 changes: 0 additions & 2 deletions docs/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,5 @@ title: Why you need this generator?
3. Attention to Developer experience for great productivity.
4. Preservation and replication of low-level best practices.

## How does Universal React addresses above concerns?

With **Reuse, Replicate and Reduce** philosophy at its core Universal React is an accelerator to generate SSR, SSG or Micro-Apps with essential tooling to enable great dev experience and solution quality.

0 comments on commit ad3ac46

Please sign in to comment.