Skip to content

Commit 4b394f8

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Fixed Documenation
1 parent 6fae711 commit 4b394f8

7 files changed

Lines changed: 43 additions & 157 deletions

File tree

docs/Add-Semantic-release-capability-in-each-Arch-type.md

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

docs/generator.md

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

docs/intro.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,47 @@ sidebar_label: Getting Started
77

88
# Universal React
99

10-
A community accepted and reliable Front End Dev Ecosystem based on React & Next, that can be utilized as baseline for
11-
development of all types of projects, to achieve dependable delivery standards. This
12-
ecosystem doesn't intend to provide lot of out of the box code/components but a
13-
well configured development environment and delivery pipeline, having balanced focus to
14-
Static Code Quality, Performance, Processes, Security, Testability and Best Practices.
15-
This boilerplate will help project teams in building applications with great quality, by
16-
giving them more time to focus on business problems rather than web development chores.
17-
18-
## Ecosystem of this reference architecture 🎉
19-
20-
- **Development Environment:** Storybook integrated for developing and showcasing components.
21-
- **Flow typed:** All components are FlowTyped and Flow Type checked.
10+
An accelerator for setting-up scalable frontend architecture with Next.js and React.
11+
12+
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.
13+
14+
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.
15+
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.
2221
- **Static Code Quality checks and formatting:** Javascript and CSS linting using Eslint, StyleLint and Prettier.
23-
- **Component scaffolding:** Consistently generate components using Plop.
24-
- **Git Hooks:** Pre-commit, Pre-push and pre-publish using Husky.
25-
- **Unit testing framework:** with Jest and Enzyme.
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.
2625
- **Theme and Styling:** with Styled Components.
27-
- **Next.js:** to render react application server side and more.
28-
- **PWA:** application.
29-
- **Dynamic Authoring:** of pages with headless CMS.
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+
3035

3136
## Main Technology Dependencies
3237

3338
1. React
3439
2. Next.js
35-
3. Redux
40+
3. Turborepo
3641
4. Node.js
42+
4. Python
3743

38-
## Installation
39-
40-
Fork the repository & install dependencies using the yarn/npm command line tools.
44+
## Uses
4145

4246
```sh
43-
yarn install
44-
yarn run flow:install
47+
npx create-universal-react
4548
```
4649

47-
flow:install will search the [`libdef`](https://github.com/flow-typed/flow-typed/blob/master/README.md) repo and download all the libdefs that are relevant for our project and install them for us.
50+
This will run the universal-react CLI, then you can simply interact with command-prompt to generate 3 different kind of applications in a Monorepo structure.
4851

4952
### Contributors
5053

docs/monorepo.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: monorepo
3+
title: Monorepo
4+
sidebar_label: Monorepo
5+
---
6+
7+
# Setup Monorepo structure with Turborepo
8+
9+
Monorepos are incredible for productivity, especially on the frontend, but the tooling can be a nightmare. [Turborepo](https://turborepo.org/) makes it easy.
10+

docs/universal-react.md

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

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
module.exports = {
22
title: 'Universal React Docs',
33
tagline:
4-
'A community accepted and reliable Front End Dev Ecosystem based on React & Next',
4+
'An accelerator for setting-up scalable frontend architecture with Next.js and React.',
55
url: 'https://github.com/',
66
baseUrl: '/universal-react-docs/',
77
favicon: 'img/favicon.ico',

src/pages/index.js

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ const features = [
1212
imageUrl: 'img/undraw_docusaurus_mountain.svg',
1313
description: (
1414
<>
15-
Creates a boilerplate which will help project teams in building applications with great quality,
16-
by giving them more time to focus on business problems rather than web development chores.
15+
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.
1716
</>
1817
),
1918
},
@@ -22,17 +21,16 @@ const features = [
2221
imageUrl: 'img/undraw_docusaurus_tree.svg',
2322
description: (
2423
<>
25-
Has balanced focus to Static Code Quality,
26-
Performance, Processes, Security, Testability and Best Practices.
24+
Lets you focus on business problems rather than web development chores by addressing Architecture, Tooling, Code Quality, Scaffolding, Testing, Best Practices and most importantly Developer experience.
2725
</>
2826
),
2927
},
3028
{
31-
title: <>Powered by React</>,
29+
title: <>How to get started?</>,
3230
imageUrl: 'img/undraw_docusaurus_react.svg',
3331
description: (
3432
<>
35-
Community accepted and reliable Front End Dev Ecosystem based on React & Next.
33+
Run <strong>npx create-universal-react</strong> This will run the create-universal-react CLI, then you can simply interact with command-prompt to generate 3 different kind of applications in a Monorepo structure.
3634
</>
3735
),
3836
},

0 commit comments

Comments
 (0)