Skip to content

Commit fc94e46

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Updated Documentation Structure and Added More details.
Added Logo
1 parent 1bb8bf8 commit fc94e46

16 files changed

Lines changed: 180 additions & 60 deletions

docs/adoption.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: adoption
3+
title: Adoption guide
4+
---
5+

docs/contribution.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: contribution
3+
title: Contribution guide
4+
---
5+

docs/features.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: features
3+
title: Capability Summary
4+
---
5+
6+
## Ecosystem of this reference architecture generator 🎉
7+
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.
19+
- **Mocking:** Mock REST and GraphQl APIs.
20+
- **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+

docs/how.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: how
3+
title: How this generator works?
4+
sidebar_label: How Universal React works?
5+
---
6+

docs/intro.md

Lines changed: 11 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,16 @@
11
---
22
id: intro
3-
title: Getting Started
4-
sidebar_label: Getting Started
3+
title: Universal React
54
---
6-
[![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)
75

8-
# Universal React
6+
[![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)
97

108
An accelerator for setting-up scalable frontend architecture with Next.js and React.
119

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

1412
This will help project teams in building applications with great quality, by giving them more time to focus on business problems rather than web development chores.
1513

16-
## Ecosystem of this reference architecture generator 🎉
17-
18-
- **Scalable Architecture:** Generate SSG, SSR and Micro-App.
19-
- **Development Environment:** Monorepo setup along with Storybook integrated for developing and showcasing components.
20-
- **Micro Frontend:** Develop Micro Frontend architecture with Module Federation.
21-
- **Static Code Quality checks and formatting:** Javascript and CSS linting using Eslint, StyleLint and Prettier.
22-
- **Component scaffolding:** Consistently generate components, services and pages using [Generate-Plop](https://github.com/pagesource/component-generator).
23-
- **Git Hooks:** Pre-commit, Pre-push using Husky.
24-
- **Testing:** Unit testing with Jest, RTL and Test Cafe for E2E.
25-
- **Theme and Styling:** with Styled Components.
26-
- **Next.js:** To develop SSR and SSG with great ease.
27-
- **PWA:** Develop offline apps or just performant.
28-
- **Authoring:** Made easy with Markdown-to-JSX.
29-
- **Mocking:** Mock REST and GraphQl APIs.
30-
- **Localization:** Switch content based on language preference.
31-
- **State Management:** Lightest state management with Context APi and [Smart-Context](https://www.npmjs.com/package/smart-context).
32-
- **Data Fetching:** Change the old way of Data Fetching with [React Query](https://react-query.tanstack.com/).
33-
- **Type Safe:** TypeScript by Default.
34-
35-
36-
## Main Technology Dependencies
37-
38-
1. React
39-
2. Next.js
40-
3. Turborepo
41-
4. Node.js
42-
4. Python
43-
4414
## Uses
4515

4616
```sh
@@ -51,12 +21,19 @@ This will run the universal-react CLI, then you can simply interact with command
5121

5222
[![CLI Generator Features by Rakesh Kumar 10](https://s7.gifyu.com/images/Banner018d3b1cbb27ffe53f.jpg)](https://web.microsoftstream.com/video/3b7ca6eb-d0ac-47e9-819b-d3e5e398ba09 "CLI Generator Features by Rakesh Kumar 10")
5323

54-
### Pre Requisites
24+
## Main Tech Dependencies
25+
26+
1. React
27+
2. Next.js
28+
3. Turborepo
29+
30+
### Uses Prerequisites
5531
1. Node >= 14.17.6
5632
2. NPM >= 7.0.0
5733
3. Python Latest Version
5834

59-
### Contributors
35+
36+
## Contributors
6037

6138
This project exists thanks to all the people who contribute.
6239
<a href="https://github.com/pagesource/universal-react-v2/graphs/contributors"><img src="https://opencollective.com/universal-react-v2/contributors.svg?width=890&button=false" /></a>

docs/quality-control.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: qualiy-control
3-
title: qualiy-control
2+
id: quality-control
3+
title: Static Quality Control
44
sidebar_label: Quality Control
55
---
66

docs/road-map.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: road-map
3+
title: Future road map
4+
---
5+

docs/support.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: support
3+
title: Support Options
4+
sidebar_label: Support
5+
---
6+

docs/what.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: what
3+
title: What this generator can achieve?
4+
---
5+
6+

docs/why.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
id: why
3+
title: Why we need this generator?
4+
---
5+
6+
## Pain Points of Frontend Development!
7+
8+
1. **Reinventing the wheel** when setting up new projects.
9+
2. Maturity and quality of the solution depends on the architect on the project.
10+
3. Delays setting up dev eco-systems, quality gates and pipelines.
11+
4. Overall lack of efficiency, as replication of best practices isn’t easy.
12+
13+
## How does Universal React addresses above concerns?
14+
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.
19+
20+
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.
21+

0 commit comments

Comments
 (0)