-**Template React project with full TypeScrip and SSR support.**
+**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.
@@ -34,8 +34,8 @@ Thus, the goal of this project is to **collect in one place all the most common
Core:
- **React** 18+ (**Preact** 10+ as an option, see [comparison](#react-vs-preact) below)
-- **webpack** 5+ (with optional **SWC** support and SSR or static build)
-- **TypeScript** (with strict rules, including webpack configuration)
+- **webpack** 5+ (with optional **SWC** support and SSR or static build; [why not Vite?](#why-not-vite))
+- **TypeScript** (with strict rules, including webpack configuration)
SSR:
@@ -57,14 +57,19 @@ API:
- **RTK Query**
+i18n (Internationalization):
+
+- **Lightweight custom solution** based on Redux (with async loading and SSR support; [why not any common i18n package?](#why-not-any-common-i18n-package))
+
Styles:
- **(S)CSS modules** (with TypeScript support)
Linters:
-- **ESLint**
+- **TS Standard** (TypeScript Style Guide, with linter and automatic code fixer based on [StandardJS](https://standardjs.com/))
- **Stylelint** (including rules order)
+- **Prettier**
Tests:
@@ -127,19 +132,19 @@ Live preview:
1. Build the project (production bundle will be in the `"dist"` folder):
- `npm run build`
+ `npm run build`
- or with Webpack Bundle Analyzer report server:
+ or with Webpack Bundle Analyzer report server:
- `npm run build:report`
+ `npm run build:report`
2. Run a server:
- `npm run run`
+ `npm run run`
3. You can test the server locally:
- `http://localhost:3000/`
+ `http://localhost:3000/`
### Static development mode with hot reload
@@ -177,21 +182,30 @@ All configuration is available in files with constants:
- `src\constants` - a directory with app files with configuration constants
- `src\server\constants.ts` - contains a server port and render to stream options
+### 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.
+
+As for the speed: you can check this article - [Storybook Performance: Vite vs Webpack](https://storybook.js.org/blog/storybook-performance-from-webpack-to-vite/). As you can see - Webpack could still be fast enough. React Proto has such configurations. In `webpack\constants.ts` you can switch on SWC and Lazy Compilation.
+
+Also, I'm looking forward to [Turbopack](https://turbo.build/pack) - the Rust-powered successor to Webpack. Now it is available only in Next.js, but I hope the future migration from the Wepback will be smooth because the principle of configuration should be the same.
+
### React vs Preact
In `webpack\constants.ts` you can choose to use [Preact](https://preactjs.com/) library instead React itself (`IS_PREACT` boolean constant).
-
Preact is a fast and compact React-compatible Virtual DOM library. But because its community is much smaller, you can face with some incompatibility with React API and functionality, especially with new ones. Also some tests show some frame drops during moving a lot of elements. Below you can see a bundle size comparison of no-SSR version of the sample application of this repository (according to Webpack Bundle Analyzer):
-| | React | Preact |
-|----|----|----|
-| Parsed | 274.25 KB | 159.7 KB |
-| Gzipped | 89.58 KB | 53.88 KB |
+| | React | Preact |
+| ------- | --------- | -------- |
+| Parsed | 278.75 KB | 164.82 KB |
+| Gzipped | 91.11 KB | 55.59 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.
## Documentation
-*Coming soon.*
+_Coming soon._
One of the goals of this project is to provide some common solutions in React development and to clarify why they were chosen and how they work. So, such information will be present in this documentation in an orderly fashion.
diff --git a/jest.config.ts b/jest.config.ts
index c4d8da1..2dbf6e8 100644
--- a/jest.config.ts
+++ b/jest.config.ts
@@ -1,4 +1,4 @@
-import type { Config } from 'jest';
+import type { Config } from 'jest'
const config: Config = {
verbose: true,
@@ -6,11 +6,13 @@ const config: Config = {
testEnvironment: 'jsdom',
moduleNameMapper: {
'\\.(css|less|scss|sss|styl)$': 'identity-obj-proxy',
- '\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)(\\?.+)?$': 'identity-obj-proxy',
+ '\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)(\\?.+)?$':
+ 'identity-obj-proxy',
'^api(.*)$': '