Overview:

This product is a SSR (Server-Side Rendering) Boilerplate that can be used as a starting point for developing SSR applications. It supports features such as SSR, HMR (Hot Module Replacement), code splitting, SPA (Single Page Application) mode, polyfills, and PWA (Progressive Web App) startup project. The installation process involves setting up the project, adding environment variables, and starting the project in different modes.

Features:

• SSR: Server-Side Rendering for improved performance and SEO.
• HMR: Hot Module Replacement for faster development cycle.
• Code splitting: Splitting code into smaller chunks to optimize loading time.
• SPA mode: Support for running the project in Single Page Application mode.
• Polyfills: Enable support for older browsers by including necessary polyfills.
• PWA: Support for creating Progressive Web App with offline capabilities.

Installation:

1. Project setup:

   • Run the command [command] to set up the project.

2. Environment variables:

   • Add a .env file based on the provided .env.example.
   • To add a new environment variable:
     • Add it to the .env file.
     • Add its name to @types/env/index.d.ts for TypeScript support.
     • If the variable needs to be accessible from both client and server, add its name to the setEnvVars function in common/env/env.util.
   • Access the variables using the getEnvVars function.

3. Starting the project:

   • To start the project in SSR mode, run the command [command].
   • To start the project in SPA mode, run the command [command].
   • To start the project in Prod mode, run the command [command].

   The application can be accessed at http://localhost:3000.

Summary:

This SSR Boilerplate project provides a starting point for developing server-side rendered applications. It includes features like SSR, HMR, code splitting, SPA mode, polyfills, and PWA support. The installation process involves setting up the project, adding environment variables, and starting the project in different modes. With this boilerplate, developers can quickly start their SSR applications and easily customize it to their needs.