Skip to content

Commit 47120cb

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Updated Docs:
1. Fixed logo size on intro page 2. Added content for adoption guide. 3. Added road map items. 4. deleted suppor page.
1 parent b9307c5 commit 47120cb

File tree

8 files changed

+66
-39
lines changed

8 files changed

+66
-39
lines changed

docs/adoption.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,21 @@ Universal React accelerator can be adopted into your projects in multiple ways.
1717

1818
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.
1919
2. **Clone the Generator**: You can clone the generator, customize it as per your organization needs and publish it to artifactory.
20+
21+
## How Universal React team can support adoption.
22+
23+
1. RFP support.
24+
2. Client pitches.
25+
3. Feature enhancements and customization.
26+
4. Continuous bug fixes and releases.
27+
5. Detailed walk through sessions.
28+
29+
We have a [future road map](/universal-react-docs/docs/road-map/) to continuously evolve this tool and make it even better.
30+
31+
## How much time you save when using this accelerator?
32+
33+
There are two ways of looking at potential effort saves:
34+
35+
1. It helps you save the most important time at the start of the project, by providing a dependable dev ecosystem. A rough estimate of time saved for off the self (`npx create-universal-react`) implementation is 2 Weeks. Since we have a lot of best practices and optional features baked-in. Owing to its evolving nature, it continues to add value throughout the project life cycle. Therefore actual effort saved is much more.
36+
37+
2. If you are looking to build a similar CLI generator for customized on-prem uses, adopting and publishing this tool into on-prem artifactory can save at least 2 months.

docs/features.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,26 @@ title: Features Summary
55

66
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.
77

8-
## Ecosystem of this reference architecture generator 🎉
8+
## Ecosystem of this generator 🎉
99

1010
| Feature | Uses | Configurability | Optional |
1111
| ------ | ------ | ------ | ------|
1212
| Monorepo development environment | [Turborepo](https://turborepo.org/) | No | No|
1313
| SSR & SSG | [Next.js](https://nextjs.org/) | No | No
14-
| Micro Frontend | [Module Federation](https://webpack.js.org/concepts/module-federation/) | No | No
15-
| Component Scaffolding | [Generate-Plop](https://github.com/pagesource/component-generator) | No | Yes
16-
| State Management | [Smart-Context](https://www.npmjs.com/package/smart-context) | No | No
17-
| Remote Data | [React Query](https://react-query.tanstack.com/) | No | No
18-
| Unit Testing | [Jest](https://jestjs.io/) & [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) | No | No
14+
| Micro Frontend | [Module Federation](https://webpack.js.org/concepts/module-federation/) | Yes | Yes
15+
| Component Scaffolding | [Generate-Plop](https://github.com/pagesource/component-generator) | Yes | Yes
16+
| State Management | [Smart-Context](https://www.npmjs.com/package/smart-context) | Yes | No
17+
| Remote Data | [React Query](https://react-query.tanstack.com/) | Yes | No
18+
| Unit Testing | [Jest](https://jestjs.io/) & [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) | Yes | No
1919
| E2E Testing automation | [Test Cafe](https://testcafe.io/) | Yes | Yes
20-
| Theme & Styling | [Stitches](https://stitches.dev/) | No | No
21-
| Generic Component Library | [Next UI](https://nextui.org/) | No | No
22-
| Component Browsing | [Storybook](https://storybook.js.org/). | No | No
23-
| Git Hooks | [Husky](https://typicode.github.io/husky/#/) | No | No
24-
| PWA | [Workbox](https://developer.chrome.com/docs/workbox/) | No | Yes
25-
|Authoring | [Markdown-to-JSX](https://www.npmjs.com/package/markdown-to-jsx) | No | No
20+
| Theme & Styling | [Stitches](https://stitches.dev/) | Yes | No
21+
| Generic Component Library | [Next UI](https://nextui.org/) | Yes | Yes
22+
| Component Dev | [Storybook](https://storybook.js.org/). | Yes | No
23+
| Git Hooks | [Husky](https://typicode.github.io/husky/#/) | Yes | No
24+
| PWA | [Workbox](https://developer.chrome.com/docs/workbox/) | Yes | Yes
25+
|Authoring | [Markdown-to-JSX](https://www.npmjs.com/package/markdown-to-jsx) | Yes | Yes
2626
| Scaffolding | [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) | No | No
27-
| Typesafe | [TypeScript](https://www.typescriptlang.org/). | No | No
28-
|Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | No
29-
|Localization |NA | No| No
30-
|Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No
27+
| Typesafe | [TypeScript](https://www.typescriptlang.org/). | Yes | No
28+
| Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | Yes
29+
| Localization and Logging |NA | Yes | No
30+
| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No

docs/intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ title: Universal React
55

66
[![Forks](https://img.shields.io/github/forks/pagesource/universal-react-v2)](https://img.shields.io/github/forks/pagesource/universal-react-v2) [![Stars](https://img.shields.io/github/stars/pagesource/universal-react-v2)](https://img.shields.io/github/stars/pagesource/universal-react-v2) [![License](https://img.shields.io/github/license/pagesource/universal-react-v2)](https://img.shields.io/github/license/pagesource/universal-react-v2)
77

8+
![UniversalReact](/img/logo.svg)
9+
810
An accelerator for setting-up scalable frontend architecture with React and Next.js.
911

1012
This accelerator is a command line tool for generating SSR, SSG & Micro-App type of applications. This enables you to setup a full-fledged Micro Frontend development ecosystem with essential tooling for great dev experience and delivery quality.

docs/road-map.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,14 @@ id: road-map
33
title: Future road map
44
---
55

6+
There are many additional capabilities we are looking forward to add. Some of those are listed here in order of priority. We are open to take additional feature requests from out community through [issus page](https://github.com/pagesource/universal-react-v2/issues).
7+
8+
1. Configuration Management.
9+
2. CI/CD Pipelines Templates.
10+
3. Telemetry
11+
4. Industry Specific Solutions
12+
5. Analytics
13+
6. Redis integration with SSR arch type.
14+
7. Edge Computing.
15+
16+

docs/support.md

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

docs/why.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ title: Why you need Universal React?
1818
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.
1919

2020
## Industry Comparison
21-
| | Create react app | Create Next app | Universal react app |
21+
| | Create React App | Create Next App | Universal React App |
2222
| ------ | ------ | ------ | ------ |
2323
| SSR, SSG | No | Yes | Yes
24-
| MicroApp | No | No | Yes
25-
| Configurability | Not much room for configuration | Almost everything is configurable | Almost everything is configurable
26-
| Monorepo support | Not out of the box | Not out of the box | Yes, comes with turborepo setup
24+
| MicroApp | Yes | No | Yes
25+
| Configurability | Low | High | Very High
26+
| Monorepo setup | No | No | Yes, with Turborepo
2727
| Typescript | Yes | Yes | Yes
28-
| Inbuilt Unit Testing setup | No | No | Yes
29-
| Inbuilt Storybook setup | No | No | Yes
30-
| Integrated design system | No | No | Yes, using Nextui
31-
| Inbuilt Loader | No | No | Yes
32-
| Smart Context | No | No | Yes
33-
| Integrated browser & server logger | No | No | Yes
34-
| Integrated Component generator | No | No | Yes, using generate-plop
35-
| Module Federation base setup | No | No | Yes
36-
|Quality control cofiguration setup | No | No | Yes
37-
| E2E automation | No | No | Yes, using Test Cafe
38-
| PWA | No | No | Yes, using workbox
28+
| Unit Testing setup | Yes | Yes | Yes
29+
| Inbuilt Storybook | No | No | Yes
30+
| Design system | No | No | Yes
31+
| Micro App Loader | No | No | Yes
32+
| State Management | No | No | Yes, with Smart Context
33+
| Browser & Server logger | No | No | Yes
34+
| Component generator | No | No | Yes, with Generate Plop
35+
| Module Federation | No | No | Yes
36+
| Quality control config | No | No | Yes
37+
| E2E automation | No | No | Yes, with Test Cafe
38+
| PWA | No | No | Yes, with Workbox
3939

4040
## Impact and Efficiency
4141

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
someSidebar: {
3-
Introduction: ['intro', 'features', 'why', 'how', 'road-map', 'contribution', 'adoption', 'support'],
3+
Introduction: ['intro', 'features', 'why', 'how', 'road-map', 'contribution', 'adoption'],
44
Features: ['monorepo', 'smart-context', 'design-system', 'atomic-design', 'loader', 'logger', 'generate-plop', 'module-federation', 'storybook', 'quality-control', 'unit-testing' ],
55
},
66
};

src/css/custom.css

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,6 @@
2222
display: block;
2323
margin: 0 calc(-1 * var(--ifm-pre-padding));
2424
padding: 0 var(--ifm-pre-padding);
25-
}
25+
}
26+
27+
img[alt=UniversalReact] { width: 150px; }

0 commit comments

Comments
 (0)