Skip to content

Commit 1aaf17d

Browse files
Add READMEs for RSC templates (#144)
1 parent 2fb1d62 commit 1aaf17d

File tree

2 files changed

+142
-0
lines changed

2 files changed

+142
-0
lines changed

unstable_rsc-parcel/README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Welcome to React Router! (Experimental RSC)
2+
3+
⚠️ **EXPERIMENTAL**: This template demonstrates React Server Components with React Router. This is experimental technology and not recommended for production use.
4+
5+
A modern template for exploring React Server Components (RSC) with React Router, powered by Parcel.
6+
7+
## Features
8+
9+
- 🧪 **Experimental React Server Components**
10+
- 🚀 Server-side rendering with RSC
11+
- ⚡️ Hot Module Replacement (HMR)
12+
- 📦 Asset bundling and optimization with Parcel
13+
- 🔄 Data loading and mutations
14+
- 🔒 TypeScript by default
15+
- 🎉 TailwindCSS for styling
16+
- 📖 [React Router docs](https://reactrouter.com/)
17+
- 📚 [React Server Components guide](https://reactrouter.com/how-to/react-server-components)
18+
19+
## Getting Started
20+
21+
### Installation
22+
23+
Install the dependencies:
24+
25+
```bash
26+
npm install
27+
```
28+
29+
### Development
30+
31+
Start the development server with HMR:
32+
33+
```bash
34+
npm run dev
35+
```
36+
37+
Your application will be available at `http://localhost:1234` (Parcel default).
38+
39+
## Building for Production
40+
41+
Create a production build:
42+
43+
```bash
44+
npm run build
45+
```
46+
47+
## Running Production Build
48+
49+
Run the production server:
50+
51+
```bash
52+
npm start
53+
```
54+
55+
## Understanding React Server Components
56+
57+
This template includes three entry points:
58+
59+
- **`entry.rsc.tsx`** - React Server Components entry point
60+
- **`entry.ssr.tsx`** - Server-side rendering entry point
61+
- **`entry.browser.tsx`** - Client-side hydration entry point
62+
63+
Learn more about React Server Components with React Router in our [comprehensive guide](https://reactrouter.com/how-to/react-server-components).
64+
65+
## Styling
66+
67+
This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
68+
69+
---
70+
71+
Built with ❤️ using React Router.

unstable_rsc-vite/README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Welcome to React Router! (Experimental RSC)
2+
3+
⚠️ **EXPERIMENTAL**: This template demonstrates React Server Components with React Router. This is experimental technology and not recommended for production use.
4+
5+
A modern template for exploring React Server Components (RSC) with React Router, powered by Vite.
6+
7+
## Features
8+
9+
- 🧪 **Experimental React Server Components**
10+
- 🚀 Server-side rendering with RSC
11+
- ⚡️ Hot Module Replacement (HMR)
12+
- 📦 Asset bundling and optimization with Vite
13+
- 🔄 Data loading and mutations
14+
- 🔒 TypeScript by default
15+
- 🎉 TailwindCSS for styling
16+
- 📖 [React Router docs](https://reactrouter.com/)
17+
- 📚 [React Server Components guide](https://reactrouter.com/how-to/react-server-components)
18+
19+
## Getting Started
20+
21+
### Installation
22+
23+
Install the dependencies:
24+
25+
```bash
26+
npm install
27+
```
28+
29+
### Development
30+
31+
Start the development server with HMR:
32+
33+
```bash
34+
npm run dev
35+
```
36+
37+
Your application will be available at `http://localhost:5173`.
38+
39+
## Building for Production
40+
41+
Create a production build:
42+
43+
```bash
44+
npm run build
45+
```
46+
47+
## Running Production Build
48+
49+
Run the production server:
50+
51+
```bash
52+
npm start
53+
```
54+
55+
## Understanding React Server Components
56+
57+
This template includes three entry points:
58+
59+
- **`entry.rsc.tsx`** - React Server Components entry point
60+
- **`entry.ssr.tsx`** - Server-side rendering entry point
61+
- **`entry.browser.tsx`** - Client-side hydration entry point
62+
63+
Learn more about React Server Components with React Router in our [comprehensive guide](https://reactrouter.com/how-to/react-server-components).
64+
65+
## Styling
66+
67+
This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
68+
69+
---
70+
71+
Built with ❤️ using React Router.

0 commit comments

Comments
 (0)