Skip to content

Commit

Permalink
TS5 + Redux 5 + Persist
Browse files Browse the repository at this point in the history
  • Loading branch information
StopNGo committed Dec 12, 2023
1 parent e9d6886 commit a6fbc35
Show file tree
Hide file tree
Showing 37 changed files with 4,724 additions and 16,962 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
16
18
10 changes: 8 additions & 2 deletions .stylelintrc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": [
"stylelint-config-standard-scss",
"stylelint-config-idiomatic-order"
"stylelint-config-clean-order"
],
"plugins": [
"stylelint-use-nesting"
Expand All @@ -10,7 +10,13 @@
"max-nesting-depth": 3,
"declaration-property-value-no-unknown": true,
"scss/selector-no-redundant-nesting-selector": true,
"csstools/use-nesting": "always"
"csstools/use-nesting": "always",
"selector-pseudo-class-no-unknown": [
true,
{
"ignorePseudoClasses": ["global"]
}
]
},
"ignoreFiles": ["dist/**/*.*", "coverage/**/*.*"]
}
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# React Proto - React TypeScript Boilerplate

![node.js@16](https://img.shields.io/badge/node.js-16-339933?style=for-the-badge&logo=nodedotjs) ![typescript@4](https://img.shields.io/badge/typescript-4-3178C6?style=for-the-badge&logo=typescript) ![reactjs@18](https://img.shields.io/badge/Reactjs-18-61DAFB?style=for-the-badge&logo=react) ![webpack@5](https://img.shields.io/badge/webpack-5-8dd6f9?style=for-the-badge&logo=webpack) ![sass@1.5](https://img.shields.io/badge/sass-1.5-CC6699?style=for-the-badge&logo=sass) ![ts-standard](https://img.shields.io/badge/standard-ts-F3DF49?style=for-the-badge&logo=standardjs)
![node.js@21](https://img.shields.io/badge/node.js-21-339933?style=for-the-badge&logo=nodedotjs) ![typescript@5](https://img.shields.io/badge/typescript-5-3178C6?style=for-the-badge&logo=typescript) ![reactjs@18](https://img.shields.io/badge/Reactjs-18-61DAFB?style=for-the-badge&logo=react) ![webpack@5](https://img.shields.io/badge/webpack-5-8dd6f9?style=for-the-badge&logo=webpack) ![sass@1.6](https://img.shields.io/badge/sass-1.6-CC6699?style=for-the-badge&logo=sass) ![ts-standard](https://img.shields.io/badge/standard-ts-F3DF49?style=for-the-badge&logo=standardjs)

<img align="right" width="100" src="src/assets/images/logo.png">

**Template React project with full TypeScript and SSR support.**

This project is a compilation of different approaches in React development that allows not only to start a new project quickly, but to learn how it works under the hood.

---
- [Issue](#issue)
- [What's Inside](#whats-inside)
- [The App](#the-app)
- [How to Use](#how-to-use)
- [Basic Project Configuration](#basic-project-Configuration)
- [General Notices](#general-notices)
- [Documentation](#documentation)
- [Changes](#changes)
- [Feedback](#feedback)
---

## Issue
Expand Down Expand Up @@ -43,7 +53,7 @@ SSR:

State:

- **Redux** 4+
- **Redux** 5 (with custom state persisting middleware; [why not redux-persist package?](#why-not-redux-persist-package))

Router:

Expand Down Expand Up @@ -82,7 +92,9 @@ Other:

- API request caching (powered by RTK Query)
- Data prefetching on server side
- State persisting to Local Storage
- Hot reload (including state, style and server code hot reloading)
- HOC for preventing component rendering on the server
- VSCode support with error highlight and on save fixes
- Script for fast component creation
- Optional Service worker and offline status detector
Expand Down Expand Up @@ -174,14 +186,15 @@ ncu -u
npm i
```

## Basic App Configuration
## Basic Project Configuration

All configuration is available in files with constants:

- `webpack\constants.ts` - contains working directories, SWC option and other related to bundling staff
- `src\constants` - a directory with app files with configuration constants
- `src\server\constants.ts` - contains a server port and render to stream options

## General Notices
### Why not Vite

Vite is an excellent new generation bundler that could speed up your development process. However, you can face with some lack of flexibility and compatibility especially in big projects that need a lot of specific configurations. Also, webpack has many good plugins that are not compatible with Vite.
Expand All @@ -198,11 +211,14 @@ Preact is a fast and compact React-compatible Virtual DOM library. But because i

| | React | Preact |
| ------- | --------- | -------- |
| Parsed | 278.75 KB | 164.82 KB |
| Gzipped | 91.11 KB | 55.59 KB |
| Parsed | 260.92 KB | 147.72 KB |
| Gzipped | 86.22 KB | 51.11 KB |

### Why not any common i18n package?
You can freely integrate any React compatible i18n solution. But if React Proto already uses Redux and RTK, why just not use them for this task? Therefore, I have created a custom internationalization solution with a minimum additional code. It supports translations dynamic loading, server side rendering based on user acceptable languages, strict typing, etc. At the moment it just does not support string processing like pluralization, but it could easily be added later.

### Why not redux-persist package?
As for me this solution is overcomplicated in most of cases. It definitely has a lot of "storage engines", state version control and etc., but smart using of Redux Middlewares and Listeners can cover all this functionality in a more precise way.
## Documentation

_Coming soon._
Expand Down
Loading

0 comments on commit a6fbc35

Please sign in to comment.