aboutsummaryrefslogtreecommitdiff
path: root/examples/framework-react/README.md
blob: 3701554be3b01f7e261a058633e8b276d7711f3e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Using React with Astro

This example showcases Astro's built-in support for [React](https://reactjs.org/).

## Installation

### Automatic

Bootstrap your Astro project with this template!

```shell
npm init astro -- --template framework-react
```

### Manual

To use React components in your Astro project:

1. Install `@astrojs/renderer-react`

    ```shell
    npm i @astrojs/renderer-react
    ```

2. Add `"@astrojs/renderer-react"` to your `renderers` in `astro.config.mjs`.

    ```js
    export default {
      renderers: [
        "@astrojs/renderer-react",
        // optionally, others...
      ]
    }
    ```

## Usage

Write your React components as `.jsx` or `.tsx` files in your project.