You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/intro.md
+28-25Lines changed: 28 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,44 +7,47 @@ sidebar_label: Getting Started
7
7
8
8
# Universal React
9
9
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.
22
21
-**Static Code Quality checks and formatting:** Javascript and CSS linting using Eslint, StyleLint and Prettier.
-**Git Hooks:** Pre-commit, Pre-push and pre-publish using Husky.
25
-
-**Unit testing framework:** with Jestand 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.
26
25
-**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
+
30
35
31
36
## Main Technology Dependencies
32
37
33
38
1. React
34
39
2. Next.js
35
-
3.Redux
40
+
3.Turborepo
36
41
4. Node.js
42
+
4. Python
37
43
38
-
## Installation
39
-
40
-
Fork the repository & install dependencies using the yarn/npm command line tools.
44
+
## Uses
41
45
42
46
```sh
43
-
yarn install
44
-
yarn run flow:install
47
+
npx create-universal-react
45
48
```
46
49
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.
Monorepos are incredible for productivity, especially on the frontend, but the tooling can be a nightmare. [Turborepo](https://turborepo.org/) makes it easy.
Copy file name to clipboardExpand all lines: src/pages/index.js
+4-6Lines changed: 4 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,7 @@ const features = [
12
12
imageUrl: 'img/undraw_docusaurus_mountain.svg',
13
13
description: (
14
14
<>
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-Apptypeofapplications.ThisenablesyoutosetupaworkingMicroFrontendorSPAdevelopmentecosystemwithessentialtoolingforgreatdevexperienceanddeliveryquality.
17
16
</>
18
17
),
19
18
},
@@ -22,17 +21,16 @@ const features = [
22
21
imageUrl: 'img/undraw_docusaurus_tree.svg',
23
22
description: (
24
23
<>
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.
27
25
</>
28
26
),
29
27
},
30
28
{
31
-
title: <>Powered by React</>,
29
+
title: <>How to get started?</>,
32
30
imageUrl: 'img/undraw_docusaurus_react.svg',
33
31
description: (
34
32
<>
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.
0 commit comments