From d6c183e4dfe1ecc797af2554c15bb3dc41b21138 Mon Sep 17 00:00:00 2001 From: fzaninotto Date: Wed, 24 Jan 2024 16:40:00 +0100 Subject: [PATCH 1/2] [Doc] Remove create-react-app chapter ## Problem [create React App](https://github.com/facebook/create-react-app) is abandonware. We shouldn't encourage developers to use it. Besides, the doc index on the sidebar is super crowded. We need to remove useless entries. ## Solution - Remove the entry in the navigation - add a warning in the Create-React-App page - Keep the page to avoid 404 for external links --- docs/CreateReactApp.md | 4 +++- docs/Tutorial.md | 4 ++-- docs/navigation.html | 1 - 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/CreateReactApp.md b/docs/CreateReactApp.md index 5f42f94f857..340f18b8e30 100644 --- a/docs/CreateReactApp.md +++ b/docs/CreateReactApp.md @@ -5,7 +5,9 @@ title: "Create_React-App Integration" # Create-React-App Integration -[Create-React-App](https://create-react-app.dev/) is a convenient way to bootstrap single-page React applications. It provides a pre-configured build setup with no configuration. +[Create-React-App](https://create-react-app.dev/) allows to bootstrap single-page React applications. It provides a pre-configured build setup with no configuration. + +**Warning**: We don't recommend using Create-React-App for new applications, as it is not maintained anymore. Prefer [create-react-admin](./CreateReactAdmin.md) (based on [Vite](./Vite.md)), [Remix](./Remix.md), or [Next.js](./Nextjs.md) instead. ## Setting Up Create React App diff --git a/docs/Tutorial.md b/docs/Tutorial.md index 5009143c804..cb31e3e19f6 100644 --- a/docs/Tutorial.md +++ b/docs/Tutorial.md @@ -17,7 +17,7 @@ Here is an overview of the result: ## Setting Up -React-admin uses React. We'll use [create-react-admin](./CreateReactAdmin.md) to bootstrap a new admin: +React-admin uses React. We'll use [create-react-admin](./CreateReactAdmin.md) to bootstrap a new web application: ```sh npm init react-admin test-admin @@ -38,7 +38,7 @@ You should be up and running with an empty React admin application on port 5173: [![Empty Admin](./img/tutorial_empty.png)](./img/tutorial_empty.png) -**Tip**: Although this tutorial uses [Vite](https://vitejs.dev/) with [TypeScript](https://www.typescriptlang.org/), you can use react-admin with JavaScript if you prefer. Also, you can use [Next.js](./NextJs.md), [Remix](./Remix.md), [create-react-app](./CreateReactApp.md), or any other React framework to create your admin app. React-admin is framework-agnostic. +**Tip**: The `create-react-admin` script creates a single-page application powered by [Vite](https://vitejs.dev/) and [TypeScript](https://www.typescriptlang.org/). You can also use react-admin with JavaScript if you prefer. Additionally, you can use [Next.js](./NextJs.md), [Remix](./Remix.md), or any other React framework to create your react-admin app. React-admin is framework-agnostic. Let's take a look at the generated code. The main entry point is `index.tsx`, which renders the `App` component in the DOM: diff --git a/docs/navigation.html b/docs/navigation.html index 97577c237e6..4d711f1ecbc 100644 --- a/docs/navigation.html +++ b/docs/navigation.html @@ -15,7 +15,6 @@
  • Vite
  • Next.js
  • Remix
  • -
  • Create React App
  • Community
  • Upgrading to v4
  • From ceaf03c9055c3174cb8474fa415e41c9be7cd6d1 Mon Sep 17 00:00:00 2001 From: Francois Zaninotto Date: Thu, 25 Jan 2024 12:24:32 +0100 Subject: [PATCH 2/2] Update docs/CreateReactApp.md Co-authored-by: adrien guernier --- docs/CreateReactApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CreateReactApp.md b/docs/CreateReactApp.md index 340f18b8e30..860278acb78 100644 --- a/docs/CreateReactApp.md +++ b/docs/CreateReactApp.md @@ -7,7 +7,7 @@ title: "Create_React-App Integration" [Create-React-App](https://create-react-app.dev/) allows to bootstrap single-page React applications. It provides a pre-configured build setup with no configuration. -**Warning**: We don't recommend using Create-React-App for new applications, as it is not maintained anymore. Prefer [create-react-admin](./CreateReactAdmin.md) (based on [Vite](./Vite.md)), [Remix](./Remix.md), or [Next.js](./Nextjs.md) instead. +**Warning**: We don't recommend using Create-React-App for new applications, as it is not maintained anymore. Prefer [create-react-admin](./CreateReactAdmin.md) (based on [Vite](./Vite.md)), [Remix](./Remix.md), or [Next.js](./NextJs.md) instead. ## Setting Up Create React App