Skip to content

Commit c2c0281

Browse files
committed
verbiage on installation docs
1 parent 8f58f8c commit c2c0281

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/src/learn/start-a-new-react-project.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
## Overview
32

43
<p class="intro" markdown>
@@ -7,22 +6,21 @@ If you want to build a new app or a new website fully with ReactPy, we recommend
76

87
</p>
98

10-
119
## Built-in Backends
1210

1311
<!-- FIXME: This is reliant on https://github.com/reactive-python/reactpy/issues/1071 -->
1412

1513
!!! note
1614

17-
Some of our frameworks are considered _built-in_, meaning that compatibility for these backends are contained within `reactpy.backend.*`.
15+
Some of our backend frameworks are considered _built-in_, meaning that compatibility for these backends are contained within `reactpy.backend.*`.
1816

19-
In order to run ReactPy with these frameworks, you will need to run `reactpy.backend.*.configure(...)` on your ASGI application. This command will configure the necessary settings and routes for ReactPy to work properly.
17+
In order to use ReactPy with _built-in_ backend, you will need to run `reactpy.backend.*.configure(...)` on your ASGI application. This command will configure the necessary settings and routes for ReactPy to work properly.
2018

2119
For example, this is how you would configure ReactPy for FastAPI:
2220

23-
```python linenums="0"
24-
{% include "../../examples/python/start_a_new_react_project/configure_example.py" %}
25-
```
21+
```python linenums="0"
22+
{% include "../../examples/python/start_a_new_react_project/configure_example.py" %}
23+
```
2624

2725
### FastAPI
2826

@@ -96,6 +94,12 @@ You will need to [configure Tornado](#built-in-backends) in order to use it with
9694

9795
## External Backends
9896

97+
!!! warning "Pitfall"
98+
99+
_External_ backends have ReactPy support, but have significantly different installation and configuration instructions than _built-in_ backends.
100+
101+
Make sure to follow the configuration guide for your chosen _external_ backend.
102+
99103
### Django
100104

101105
[Django](https://www.djangoproject.com/) is a full-featured web framework that provides a batteries-included approach to web development. It includes features such as ORM, templating, authentication, and authorization. Django is a good choice for large and complex web applications.
@@ -108,7 +112,7 @@ You will need to [configure Tornado](#built-in-backends) in order to use it with
108112

109113
If you're new to Django, check out the [Django tutorial](https://docs.djangoproject.com/en/dev/intro/tutorial01/).
110114

111-
You will need to [configure Django](https://reactive-python.github.io/reactpy-django/get-started/installation/) in order to use it with ReactPy.
115+
ReactPy has unique [configuration instructions](https://reactive-python.github.io/reactpy-django/get-started/installation/) to use Django.
112116

113117
### Jupyter
114118

@@ -122,7 +126,7 @@ Jupyter is an interactive computing environment that is used for data science an
122126

123127
If you're new to Jupyter, check out the [Jupyter tutorial](https://jupyter.org/try).
124128

125-
You will need to [configure Jupyter](https://github.com/reactive-python/reactpy-jupyter#readme) in order to use it with ReactPy.
129+
ReactPy has unique [configuration instructions](https://github.com/reactive-python/reactpy-jupyter#readme) to use Jupyter.
126130

127131
### Plotly Dash
128132

@@ -136,16 +140,16 @@ Plotly Dash is a web application framework that is used to create interactive da
136140

137141
If you're new to Plotly Dash, check out the [Plotly Dash tutorial](https://dash.plotly.com/installation).
138142

139-
You will need to [configure Plotly Dash](https://github.com/reactive-python/reactpy-dash#readme) in order to use it with ReactPy.
143+
ReactPy has unique [configuration instructions](https://github.com/reactive-python/reactpy-dash#readme) to use Plotly Dash.
140144

141145
!!! info "Deep Dive"
142146

143147
<font size="4">**Can I use ReactPy without a backend framework?**</font>
144148

145-
You can not ReactPy without a backend—this project was designed to be built on-top of existing web frameworks.
149+
You can not ReactPy without a backend—this project was designed to be built on-top of existing web frameworks.
146150

147151
Here's why.
148152

149153
You can think of ReactPy as ReactJS server side rendering, but with a Python server. We rely on Python web frameworks and webservers in order to process ReactPy traffic. **This means that you can [use any Python web framework](../learn/creating-backends.md) as a ReactPy backend, as long as it supports the ASGI standard.** As your project grows with every new feature, you may want to switch backends in the future. As a result, we recommend keeping all backend-related logic within hook functions in order to make the "points of integration" between ReactPy and your backend as small as possible.
150-
151-
**If you're building a new app or a site fully with ReactPy, we recommend using your favorite backend combined with [`reactpy-router`](https://github.com/reactive-python/reactpy-router) to create a Single Page Application (SPA).**
154+
155+
**If you're building a new app or a site fully with ReactPy, we recommend using your favorite backend combined with [`reactpy-router`](https://github.com/reactive-python/reactpy-router) to create a Single Page Application (SPA).**

0 commit comments

Comments
 (0)