From c054a0507ae4699bd620ae4ca703ffa6f4b8470e Mon Sep 17 00:00:00 2001 From: anurag-verma-india <104461155+anurag-verma-india@users.noreply.github.com> Date: Fri, 29 Aug 2025 03:59:47 +0530 Subject: [PATCH 1/2] docs(GettingStarted): update and expand project setup templates section This change: - Adds instructions for Vite, CRA, Expo, and React Native templates. - Moves the Next.js `with-redux` example to a separate section as a community template. --- docs/introduction/GettingStarted.md | 33 ++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/introduction/GettingStarted.md b/docs/introduction/GettingStarted.md index cb86fd4598..5bb5359300 100644 --- a/docs/introduction/GettingStarted.md +++ b/docs/introduction/GettingStarted.md @@ -37,25 +37,38 @@ npm install @reduxjs/toolkit yarn add @reduxjs/toolkit ``` -### Create a React Redux App +### Creating a New Redux Project -The recommended way to start new apps with React and Redux is by using [our official Redux+TS template for Vite](https://github.com/reduxjs/redux-templates), or by creating a new Next.js project using [Next's `with-redux` template](https://github.com/vercel/next.js/tree/canary/examples/with-redux). +The recommended way to start new apps with Redux is to use one of our [official templates](https://github.com/reduxjs/redux-templates). These templates come pre-configured with Redux Toolkit, and include a small example app to get you started. -Both of these already have Redux Toolkit and React-Redux configured appropriately for that build tool, and come with a small example app that demonstrates how to use several of Redux Toolkit's features. +To create a new project, you can use a tool like `degit` to clone and extract the template. ```bash -# Vite with our Redux+TS template -# (using the `degit` tool to clone and extract the template) +# Vite + TypeScript npx degit reduxjs/redux-templates/packages/vite-template-redux my-app -# Next.js using the `with-redux` template -npx create-next-app --example with-redux my-app +# Create React App + TypeScript +npx degit reduxjs/redux-templates/packages/cra-template-redux-typescript my-app + +# Create React App + JavaScript +npx degit reduxjs/redux-templates/packages/cra-template-redux my-app + +# Expo + TypeScript +npx degit reduxjs/redux-templates/packages/expo-template-redux-typescript my-app + +# React Native + TypeScript +npx degit reduxjs/redux-templates/packages/react-native-template-redux-typescript my-app + +# Standalone Redux Toolkit App Structure Example +npx degit reduxjs/redux-templates/packages/rtk-app-structure-example my-app ``` -We do not currently have official React Native templates, but recommend these templates for standard React Native and for Expo: +In addition to our official templates, the community has created other templates, such as the [Next.js `with-redux` template](https://github.com/vercel/next.js/tree/canary/examples/with-redux). -- https://github.com/rahsheen/react-native-template-redux-typescript -- https://github.com/rahsheen/expo-template-redux-typescript +```bash +# Next.js + Redux +npx create-next-app --example with-redux my-app +``` ### Redux Core From 408d265206fc30d9386e9e6ed0fe8b872472c9bf Mon Sep 17 00:00:00 2001 From: anurag-verma-india <104461155+anurag-verma-india@users.noreply.github.com> Date: Fri, 29 Aug 2025 04:48:38 +0530 Subject: [PATCH 2/2] Changed degit npm module with tiged for cloning the templates --- docs/introduction/GettingStarted.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/introduction/GettingStarted.md b/docs/introduction/GettingStarted.md index 5bb5359300..f3e2d6be8f 100644 --- a/docs/introduction/GettingStarted.md +++ b/docs/introduction/GettingStarted.md @@ -41,26 +41,26 @@ yarn add @reduxjs/toolkit The recommended way to start new apps with Redux is to use one of our [official templates](https://github.com/reduxjs/redux-templates). These templates come pre-configured with Redux Toolkit, and include a small example app to get you started. -To create a new project, you can use a tool like `degit` to clone and extract the template. +To create a new project, you can use a tool like `tiged` to clone and extract the template. ```bash # Vite + TypeScript -npx degit reduxjs/redux-templates/packages/vite-template-redux my-app +npx tiged reduxjs/redux-templates/packages/vite-template-redux my-app # Create React App + TypeScript -npx degit reduxjs/redux-templates/packages/cra-template-redux-typescript my-app +npx tiged reduxjs/redux-templates/packages/cra-template-redux-typescript my-app # Create React App + JavaScript -npx degit reduxjs/redux-templates/packages/cra-template-redux my-app +npx tiged reduxjs/redux-templates/packages/cra-template-redux my-app # Expo + TypeScript -npx degit reduxjs/redux-templates/packages/expo-template-redux-typescript my-app +npx tiged reduxjs/redux-templates/packages/expo-template-redux-typescript my-app # React Native + TypeScript -npx degit reduxjs/redux-templates/packages/react-native-template-redux-typescript my-app +npx tiged reduxjs/redux-templates/packages/react-native-template-redux-typescript my-app # Standalone Redux Toolkit App Structure Example -npx degit reduxjs/redux-templates/packages/rtk-app-structure-example my-app +npx tiged reduxjs/redux-templates/packages/rtk-app-structure-example my-app ``` In addition to our official templates, the community has created other templates, such as the [Next.js `with-redux` template](https://github.com/vercel/next.js/tree/canary/examples/with-redux).