Skip to content

Commit 162991a

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Added more content
1 parent fc94e46 commit 162991a

File tree

8 files changed

+74
-34
lines changed

8 files changed

+74
-34
lines changed

docs/adoption.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
---
22
id: adoption
3-
title: Adoption guide
3+
title: Adoption Readiness
44
---
55

6+
Universal React accelerator has taken several steps to ensure the Adoption Readiness of the tool.
7+
8+
1. Being used by multiple External and few Internal projects.
9+
2. Tested through various sample applications.
10+
3. Preserves learnings from many successful projects.
11+
4. Has a Passionate Core Team to support and enhance it.
12+
5. Detailed documentation site & Video Tutorials from developers who worked upon it.
13+
14+
## Adoption Strategies
15+
16+
Universal React accelerator can be adopted into your projects in multiple ways.
17+
18+
1. **Out of the box Adoption**: You can use `npx create-universal-react`to setup your project, if you are completely aligned with [Technology choices](/universal-react-docs/docs/features/). You can make necessary tweaks and adjust these choices post initial setup.
19+
2. **Clone The Generator**: You can clone the generator, customize it as per your organization needs.

docs/features.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
---
22
id: features
3-
title: Capability Summary
3+
title: Features Summary
44
---
55

6+
This accelerator is an highly opinionated collection of tools and best practices. It is possible that you have a different take on some of these choices. Feel free to enhance your project post initial setup or clone of this generator to suit your needs.
7+
68
## Ecosystem of this reference architecture generator 🎉
79

8-
- **Scalable Architecture:** Generate SSG, SSR and Micro-App.
9-
- **Development Environment:** Monorepo setup along with Storybook integrated for developing and showcasing components.
10-
- **Micro Frontend:** Develop Micro Frontend architecture with Module Federation.
11-
- **Static Code Quality checks and formatting:** Javascript and CSS linting using Eslint, StyleLint and Prettier.
12-
- **Component scaffolding:** Consistently generate components, services and pages using [Generate-Plop](https://github.com/pagesource/component-generator).
13-
- **Git Hooks:** Pre-commit, Pre-push using Husky.
14-
- **Testing:** Unit testing with Jest, RTL and Test Cafe for E2E.
15-
- **Theme and Styling:** with Styled Components.
16-
- **Next.js:** To develop SSR and SSG with great ease.
17-
- **PWA:** Develop offline apps or just performant.
18-
- **Authoring:** Made easy with Markdown-to-JSX.
10+
- **Development Environment:** Monorepo setup with [Turborepo](https://turborepo.org/).
11+
- **Next.js:** to develop SSR and SSG with great ease.
12+
- **Micro Frontend:** architecture with [Module Federation](https://webpack.js.org/concepts/module-federation/).
13+
- **Component scaffolding:** consistently generate components, services and pages using [Generate-Plop](https://github.com/pagesource/component-generator).
14+
- **State Management:** lightest state management with Context APi and [Smart-Context](https://www.npmjs.com/package/smart-context).
15+
- **Remote Data:** change the old way of using Remote Data with [React Query](https://react-query.tanstack.com/).
16+
- **Unit Testing:** with Jest, [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) and Many custom testing utilities.
17+
- **End 2 End Testing Automation:** using [Test Cafe](https://testcafe.io/).
18+
- **Theme and Styling:** with CSS-in-JS using [Stitches](https://stitches.dev/).
19+
- **Generic Component Library:** with basic building blocks via [Next UI](https://nextui.org/).
20+
- **Component Browsing:** development and testing with [Storybook](https://storybook.js.org/).
21+
- **Git Hooks:** to validate changes on Pre-commit, Pre-push using [Husky](https://typicode.github.io/husky/#/).
22+
- **PWA:** for offline apps using [Workbox](https://developer.chrome.com/docs/workbox/).
23+
- **Authoring:** made easy with [Markdown-to-JSX](https://www.npmjs.com/package/markdown-to-jsx).
24+
- **Scaffolding:** of code using [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/).
25+
- **Type Safe:** by default using [TypeScript](https://www.typescriptlang.org/).
1926
- **Mocking:** Mock REST and GraphQl APIs.
2027
- **Localization:** Switch content based on language preference.
21-
- **State Management:** Lightest state management with Context APi and [Smart-Context](https://www.npmjs.com/package/smart-context).
22-
- **Data Fetching:** Change the old way of Data Fetching with [React Query](https://react-query.tanstack.com/).
23-
- **Type Safe:** TypeScript by Default.
24-
28+
- **Static Code Quality checks and formatting:** Javascript and CSS linting using Eslint, StyleLint and Prettier.

docs/how.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
---
22
id: how
3-
title: How this generator works?
4-
sidebar_label: How Universal React works?
3+
title: How it works?
54
---
65

6+
There are 2 Key Pillars of Universal React.
7+
8+
## 1. Accelerate React Development by instant initial setup
9+
10+
React developers can run `npx create-universal-react` generator for setting up Micro Frontend and SPA architecture with essential tooling instantly.
11+
## 2. Continuous Improvement and Support via addition of optional features
12+
13+
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.
14+
15+
## Execution flow of generator
16+
17+
Following flow chart explains the workings of generator.
18+
19+
![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)
20+
21+
## Possible Architecture Overview
22+
23+
Using this generator flow you can setup and evolve a project into following Architecture types.
24+
25+
![Architecture Types with Universal React generator](/img/universal-react-arch-types-2x.png)
26+
27+
There are 2 ways you can achieve Micro Frontend in this ecosystem.
28+
29+
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:
30+
1. You are not loading too many Micro Apps on a page.
31+
2. You don't want to change configurations of Micro App to support Module Federation.
32+
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/).
33+
34+

docs/what.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/why.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
id: why
3-
title: Why we need this generator?
3+
title: Why you need this generator?
44
---
55

66
## Pain Points of Frontend Development!
77

8-
1. **Reinventing the wheel** when setting up new projects.
8+
1. Reinventing the wheel when setting up new projects.
99
2. Maturity and quality of the solution depends on the architect on the project.
1010
3. Delays setting up dev eco-systems, quality gates and pipelines.
1111
4. Overall lack of efficiency, as replication of best practices isn’t easy.
12-
1312
## How does Universal React addresses above concerns?
13+
1. Instant initial setup of essential solutions for enterprise scale React applications.
14+
2. Continuous value addition beyond initial setup through evolving accelerators.
15+
3. Attention to Developer experience for great productivity.
16+
4. Preservation and replication of low-level best practices.
1417

15-
1. Enterprise scale React applications needs a lot more focused solutions.
16-
2. Continuous value addition beyond initial setup through accelerators.
17-
3. Developer experience needs utmost attention for great productivity.
18-
4. Preservation and replication of low-level best practices is a necessity in era of green teams.
18+
## How does Universal React addresses above concerns?
1919

2020
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.
2121

sidebars.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
someSidebar: {
3-
Introduction: ['intro', 'why', 'what', 'how', 'road-map', 'contribution', 'adoption', 'support'],
4-
Features: ['features', 'quality-control', 'smart-context', 'unit-testing', 'design-system', 'loader', 'web-component', 'logger', 'generate-plop', 'module-federation', 'monorepo', 'storybook'],
3+
Introduction: ['intro', 'why', 'how', 'features', 'road-map', 'contribution', 'adoption', 'support'],
4+
Features: ['quality-control', 'smart-context', 'unit-testing', 'design-system', 'loader', 'web-component', 'logger', 'generate-plop', 'module-federation', 'monorepo', 'storybook'],
55
},
66
};
127 KB
Loading
401 KB
Loading

0 commit comments

Comments
 (0)