Skip to content

Commit 1416f1c

Browse files
authoredApr 24, 2023
Merge pull request #8853 from marmelab/stackblitz-link
[chore] [Doc] Replace codesandbox links by stackblitz for issue reproduction
2 parents dbb8ba3 + 4f33468 commit 1416f1c

File tree

6 files changed

+12
-14
lines changed

6 files changed

+12
-14
lines changed
 

‎.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For code issues please include:
1616
* React-admin version
1717
* React version
1818
* Browser version
19-
* A code example or link to a repo, gist or running site. (hint: fork [this sandbox](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple) to create a reproducible version of your bug)
19+
* A code example or link to a repo, gist or running site. (hint: fork [this sandbox](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple) to create a reproducible version of your bug)
2020

2121
For visual or layout problems, images or animated gifs can help explain your issue.
2222
It's even better with a live reproduction test case.

‎.github/ISSUE_TEMPLATE/Bug_report.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ about: Something isn't working as expected. Please tell us!
2121
**Related code:**
2222
<!-- If you are able to illustrate the bug or feature request with an example, please provide a sample application via one of the following means: -->
2323

24-
* Preferably, a CodeSandbox forked from
25-
- https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple (v4)
26-
- https://codesandbox.io/s/github/marmelab/react-admin/tree/3.x/examples/simple (v3)
27-
* A StackBlitz forked from
24+
* Preferably, a sandbox forked from
2825
- https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple (v4)
26+
- https://codesandbox.io/s/github/marmelab/react-admin/tree/3.x/examples/simple (v3)
2927
* A link to a GitHub repo with the minimal codebase to reproduce the issue
3028

3129

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,11 @@ React-admin is designed as a library of loosely coupled React components and hoo
130130

131131
There are several examples inside the `examples` folder:
132132

133-
* `simple` ([CodeSandbox](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple), [StackBlitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple?file=src%2Findex.tsx)): a simple blog with posts, comments and users that we use for our e2e tests.
133+
* `simple` ([StackBlitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple?file=src%2Findex.tsx)): a simple blog with posts, comments and users that we use for our e2e tests.
134134
* `e-commerce`: ([demo](https://marmelab.com/react-admin-demo/), [source](https://github.com/marmelab/react-admin/tree/master/examples/demo)) A fictional poster shop admin, serving as the official react-admin demo.
135135
* `CRM`: ([demo](https://marmelab.com/react-admin-crm/), [source](https://github.com/marmelab/react-admin/tree/master/examples/crm)) A customer relationship management application
136136
* `helpdesk`: ([demo](https://marmelab.com/react-admin-helpdesk/), [source](https://github.com/marmelab/react-admin-helpdesk)) A ticketing application with realtime locks and notifications
137-
* `tutorial` ([CodeSandbox](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/tutorial)): the application built while following the [tutorial](https://marmelab.com/react-admin/Tutorial.html).
137+
* `tutorial` ([Stackblitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/tutorial)): the application built while following the [tutorial](https://marmelab.com/react-admin/Tutorial.html).
138138

139139
You can run those example applications by calling:
140140

@@ -199,7 +199,7 @@ You can use Gitpod (an open source, online VS Code-like IDE) for working on issu
199199

200200
### Testing Your Changes In The Example Apps
201201

202-
When developing, most of the time we use the **simple example** to do visual check. It's the same application that we use in CodeSandbox to reproduce errors (see https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple). The source is located under `examples/simple/`. Call `make run` to launch that example on port 8080 (http://localhost:8080). This command includes a `watch` on the react-admin source, so any of the changes you make to the react-admin packages triggers a live update of the simple example in your browser.
202+
When developing, most of the time we use the **simple example** to do visual check. It's the same application that we use in Stackblitz to reproduce errors (see https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple). The source is located under `examples/simple/`. Call `make run` to launch that example on port 8080 (http://localhost:8080). This command includes a `watch` on the react-admin source, so any of the changes you make to the react-admin packages triggers a live update of the simple example in your browser.
203203

204204
However, the simple example is sometimes too limited. You can use the **demo example** (the source for https://marmelab.com/react-admin-demo/), which is more complete. The source is located under `examples/demo/`. Call `make run-demo` to launch the demo example with a REST dataProvider, or `make run-graphql-demo` to run it with a GraphQL dataProvider. Unfortunately, due to the fact that we use Create React App for this demo, these commands don't watch the changes made in the packages. You'll have to rebuild the react-admin packages after a change (using `make build`, or the more targeted `make build-ra-core`, `make build-ra-ui-materialui`, etc.) to see the effect in the demo app.
205205

‎docs/Demos.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ A simple application with posts, comments and users that we use for our e2e test
8888

8989
![Blog demo](./img/blog_demo.png)
9090

91-
* Demo: [https://iuxnw.sse.codesandbox.io/](https://iuxnw.sse.codesandbox.io/)
92-
* Source code: [https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple)
91+
* Demo: [https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple)
92+
* Source code: [https://github.com/marmelab/react-admin/tree/master/examples/simple](https://github.com/marmelab/react-admin/tree/master/examples/simple)
9393

9494
## Broadcom Layer 7 API Hub
9595

‎examples/simple/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React-admin Simple Example
22

3-
This is the application we use for our end-to-end tests, and for reproducing bugs via CodeSandbox.
3+
This is the application we use for our end-to-end tests, and for reproducing bugs via [Stackblitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple).
44

55
## How to run
66

‎packages/react-admin/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ React-admin is designed as a library of loosely coupled React components built o
139139

140140
There are several examples inside the `examples` folder:
141141

142-
* `simple` ([CodeSandbox](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple)): a simple application with posts, comments and users that we use for our e2e tests.
143-
* `tutorial` ([CodeSandbox](https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/tutorial)): the application built while following the tutorial.
142+
* `simple` ([Stackblitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple)): a simple application with posts, comments and users that we use for our e2e tests.
143+
* `tutorial` ([Stackblitz](https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/tutorial)): the application built while following the tutorial.
144144
* `demo`: ([Live](https://marmelab.com/react-admin-demo/)) A fictional poster shop admin, serving as the official react-admin demo.
145145

146146
You can run those example applications by calling:
@@ -205,7 +205,7 @@ You can use Gitpod(An Online Open Source VS Code like IDE which is free for Open
205205

206206
### Testing Your Changes In The Example Apps
207207

208-
When developing, most of the time we use the **simple example** to do visual check. It's the same application that we use in CodeSandbox to reproduce errors (see https://codesandbox.io/s/github/marmelab/react-admin/tree/master/examples/simple). The source is located under `examples/simple/`. Call `make run` to launch that example on port 8080 (http://localhost:8080). This command includes a `watch` on the react-admin source, so any of the changes you make to the react-admin packages triggers a live update of the simple example in your browser.
208+
When developing, most of the time we use the **simple example** to do visual check. It's the same application that we use in Stackblitz to reproduce errors (see https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple). The source is located under `examples/simple/`. Call `make run` to launch that example on port 8080 (http://localhost:8080). This command includes a `watch` on the react-admin source, so any of the changes you make to the react-admin packages triggers a live update of the simple example in your browser.
209209

210210
However, the simple example is sometimes too limited. You can use the **demo example** (the source for https://marmelab.com/react-admin-demo/), which is more complete. The source is located under `examples/demo/`. Call `make run-demo` to launch the demo example with a REST dataProvider, or `make run-graphql-demo` to run it with a GraphQL dataProvider. Unfortunately, due to the fact that we use Create React App for this demo, these commands don't watch the changes made in the packages. You'll have to rebuild the react-admin packages after a change (using `make build`, or the more targeted `make build-ra-core`, `make build-ra-ui-materialui`, etc) to see the effect in the demo app.
211211

0 commit comments

Comments
 (0)
Please sign in to comment.