Merge branch 'master' into releases/october

refinedev · Oct 7, 2024 · 548cd03 · 548cd03
2 parents 6c2931a + 0b67bf5
commit 548cd03
Show file tree

Hide file tree

Showing 264 changed files with 603 additions and 26,698 deletions.
diff --git a/.github/workflows/example-previews-pr.yml b/.github/workflows/example-previews-pr.yml
@@ -6,7 +6,6 @@ on:
       - "examples/finefoods-antd/**"
       - "examples/finefoods-client/**"
       - "examples/finefoods-material-ui/**"
-      - "examples/app-crm/**"
       - "examples/pixels/**"
       - "examples/invoicer/**"
     types:
@@ -24,25 +23,24 @@ jobs:
       examples: ${{ steps.filter.outputs.changes }}
       all_examples: ${{ steps.deploy-previews-label.outputs.all_examples }}
     steps:
-    - uses: actions/checkout@v4
-    - name: Get PR labels
-      id: pr-labels
-      uses: joerick/[email protected]
-    - name: 'Check deploy previews label'
-      if: ${{ contains(steps.pr-labels.outputs.labels, ' deploy-previews ') }}
-      id: deploy-previews-label
-      run: echo 'all_examples=["finefoods-antd", "finefoods-client", "finefoods-material-ui", "app-crm", "pixels", "invoicer"]' >> $GITHUB_OUTPUT
-    - uses: dorny/paths-filter@v3
-      if: ${{ !contains(steps.pr-labels.outputs.labels, ' deploy-previews ') }}
-      id: filter
-      with:
-        filters: |
-          'finefoods-antd': 'examples/finefoods-antd/**'
-          'finefoods-client': 'examples/finefoods-client/**'
-          'finefoods-material-ui': 'examples/finefoods-material-ui/**'
-          'app-crm': 'examples/app-crm/**'
-          'pixels': 'examples/pixels/**'
-          'invoicer': 'examples/invoicer/**'
+      - uses: actions/checkout@v4
+      - name: Get PR labels
+        id: pr-labels
+        uses: joerick/[email protected]
+      - name: "Check deploy previews label"
+        if: ${{ contains(steps.pr-labels.outputs.labels, ' deploy-previews ') }}
+        id: deploy-previews-label
+        run: echo 'all_examples=["finefoods-antd", "finefoods-client", "finefoods-material-ui", "pixels", "invoicer"]' >> $GITHUB_OUTPUT
+      - uses: dorny/paths-filter@v3
+        if: ${{ !contains(steps.pr-labels.outputs.labels, ' deploy-previews ') }}
+        id: filter
+        with:
+          filters: |
+            'finefoods-antd': 'examples/finefoods-antd/**'
+            'finefoods-client': 'examples/finefoods-client/**'
+            'finefoods-material-ui': 'examples/finefoods-material-ui/**'
+            'pixels': 'examples/pixels/**'
+            'invoicer': 'examples/invoicer/**'
 
   deploy_previews:
     runs-on: ubuntu-latest

diff --git a/documentation/blog/2023-03-22-react-admin-templates.md b/documentation/blog/2023-03-22-react-admin-templates.md
@@ -57,7 +57,7 @@ Overall, the Refine CRM admin template is an excellent choice for businesses tha
 
 **Live example:** https://example.crm.refine.dev/
 
-**Source code**: https://github.com/refinedev/refine/tree/master/examples/app-crm
+**Template**: https://refine.dev/templates/crm-application/
 
 ## 2. Elstar
 

diff --git a/documentation/blog/2023-10-02-refine-crm-overview.md b/documentation/blog/2023-10-02-refine-crm-overview.md
@@ -14,7 +14,7 @@ I want to introduce our newest example app – a full-fledged React CRM (Custome
 
 👉 [Live Demo](https://example.crm.refine.dev/)
 
-👉 [You can find the source code on GitHub here](https://github.com/refinedev/refine/tree/master/examples/app-crm)
+👉 [Template](https://refine.dev/templates/crm-application/)
 
 This example is open-source, which means anyone can freely utilize and customize the source code as they see fit. It's not just another application; it's a comprehensive solution that boasts all the features and functionalities required for an accurate enterprise-level application.
 

diff --git a/documentation/blog/2024-03-26-react-hook-form.md b/documentation/blog/2024-03-26-react-hook-form.md
@@ -539,7 +539,7 @@ Notice, we have multiple validation rules for the `content` field. React Hook Fo
 
 ### Handling Submission in React Hook Formxx
 
-In React Hook Form, registered field data are accummulated in a `data` object with their `name` and field values. We handle submission of the form data with the `handleSubmit` method of the form instance.
+In React Hook Form, registered field data are accumulated in a `data` object with their `name` and field values. We handle submission of the form data with the `handleSubmit` method of the form instance.
 
 Let's now deal with submitting the data by making changes to the form we have so far. Update the `App.js` to the following code with `formInstance.handleSubmit` passed to `onSubmit` event on `<form>` element:
 

diff --git a/documentation/blog/2024-07-23-react-dashboard-libraries.md b/documentation/blog/2024-07-23-react-dashboard-libraries.md
@@ -67,7 +67,7 @@ npm create refine-app@latest
 
 - GitHub stars: +27K
 - License: MIT
-- Links: [Demo](https://example.crm.refine.dev/) | [Documentation](https://refine.dev/tutorial) | [GitHub](https://github.com/refinedev/refine/tree/master/examples/app-crm)
+- Links: [Demo](https://example.crm.refine.dev/) | [Documentation](https://refine.dev/tutorial) | [Template](https://refine.dev/templates/crm-application/)
 
 ## Ant Design pro
 

diff --git a/...entation/docs/ui-integrations/ant-design/components/basic-views/create/index.md b/...entation/docs/ui-integrations/ant-design/components/basic-views/create/index.md
@@ -703,6 +703,7 @@ Or, instead of using the `defaultButtons`, you can create your own buttons. If y
 ```tsx live disableScroll previewHeight=280px url=http://localhost:3000/posts/create
 // visible-block-start
 import { Create, SaveButton } from "@refinedev/antd";
+import { Button } from "antd";
 
 const PostCreate: React.FC = () => {
   return (

diff --git a/documentation/docs/ui-integrations/ant-design/migration-guide/index.md b/documentation/docs/ui-integrations/ant-design/migration-guide/index.md
@@ -167,7 +167,7 @@ Ant Design removed `less`, uses and recommends `CSS-in-JS` instead. You need to
 
 ### Compile errors
 
-Some users repored ([issue#1](https://discord.com/channels/837692625737613362/1056236230641209396/1056236230641209396), [issue#2](https://discord.com/channels/837692625737613362/1056592183702061177/1056592183702061177)) compile errors after upgrading from `@refinedev/[email protected]` to `@refinedev/[email protected]`. They also provided solutions.
+Some users reported ([issue#1](https://discord.com/channels/837692625737613362/1056236230641209396/1056236230641209396), [issue#2](https://discord.com/channels/837692625737613362/1056592183702061177/1056592183702061177)) compile errors after upgrading from `@refinedev/[email protected]` to `@refinedev/[email protected]`. They also provided solutions.
 
 #### Solution 1
 

diff --git a/documentation/plugins/templates.js b/documentation/plugins/templates.js
@@ -40,9 +40,10 @@ const templates = [
     images: [
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-refine-crm.png",
     ],
-    runOnYourLocalPath: "app-crm",
+    runOnYourLocalPath: null,
+    edition: "Enterprise",
     liveDemo: "https://example.crm.refine.dev/",
-    github: "https://github.com/refinedev/refine/tree/master/examples/app-crm",
+    github: null,
     reactPlatform: "Vite",
     uiFramework: "Ant Design",
     dataProvider: "Nestjs-query",
@@ -97,6 +98,7 @@ This CRM app template can be used in for various app requirements like B2B appli
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-storefront.png",
     ],
     runOnYourLocalPath: "finefoods-client",
+    edition: "Community",
     liveDemo: "https://example.refine.dev/",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-client",
@@ -105,6 +107,7 @@ This CRM app template can be used in for various app requirements like B2B appli
     dataProvider: "Rest API",
     authProvider: "Custom",
     description: `
+
 This is a template that can serve as an example for building React-based storefronts, admin panels, or internal tools using Refine. Implemented popular tools like Tailwind CSS and Next.js, which are highly demanded by the community.
 
 ### Key Features:
@@ -122,6 +125,7 @@ The source code is also open-source; feel free to use or inspect it to discover
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-finefoods-material-ui.png",
     ],
     runOnYourLocalPath: "finefoods-material-ui",
+    edition: "Community",
     liveDemo: "https://example.mui.admin.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-material-ui",
@@ -172,6 +176,7 @@ This admin panel template can be used in for various app requirements like B2B a
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-finefoods-ant-design.png",
     ],
     runOnYourLocalPath: "finefoods-antd",
+    edition: "Community",
     liveDemo: "https://example.admin.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-antd",
@@ -224,6 +229,7 @@ This admin panel template can be used in for various app requirements like B2B a
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-store.png",
     ],
     runOnYourLocalPath: "store",
+    edition: "Community",
     liveDemo: "https://store.refine.dev/",
     github: "https://github.com/refinedev/refine/tree/master/examples/store",
     reactPlatform: "Next.js",
@@ -257,6 +263,7 @@ With its production-ready status, this template offers a solid foundation for bu
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-pixels.png",
     ],
     runOnYourLocalPath: "pixels",
+    edition: "Community",
     liveDemo: "https://pixels.refine.dev/",
     github: "https://github.com/refinedev/refine/tree/master/examples/pixels",
     tutorial: "https://refine.dev/week-of-refine-supabase/",
@@ -287,6 +294,7 @@ We built this template to demonstrate how the Refine framework simplifies and sp
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-invoice-generator.png",
     ],
     runOnYourLocalPath: "invoicer",
+    edition: "Community",
     liveDemo: "https://refine-invoicer-8mk7d.ondigitalocean.app/",
     github: "https://github.com/refinedev/refine/tree/master/examples/invoicer",
     reactPlatform: "Vite",
@@ -316,6 +324,7 @@ We built this template to showcase the efficiency and ease of using the Refine f
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/video-club-win95.png",
     ],
     runOnYourLocalPath: "win95",
+    edition: "Community",
     liveDemo: "https://videoclub.refine.dev",
     github: "https://github.com/refinedev/refine/tree/master/examples/win95",
     reactPlatform: "Vite",
@@ -335,6 +344,7 @@ The source code of the CRUD app is also open-source; feel free to use or inspect
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-realworld.png",
     ],
     runOnYourLocalPath: "real-world-example",
+    edition: "Community",
     liveDemo: "https://refine-real-world.netlify.app/",
     github: "https://github.com/refinedev/real-world-example",
     reactPlatform: "Vite",
@@ -368,6 +378,7 @@ Since the source code of this RealWorld app is open-source, you have the freedom
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-multitenancy-strapi.png",
     ],
     runOnYourLocalPath: "multi-tenancy-strapi",
+    edition: "Community",
     liveDemo: "https://multi-tenancy-strapi.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/multi-tenancy-strapi",
@@ -391,6 +402,7 @@ The source code of this multitenancy app is open-source, allowing you to use or
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-ant-design-template.png",
     ],
     runOnYourLocalPath: "auth-antd",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/p/sandbox/github/refinedev/refine/tree/master/examples/auth-antd",
     github:
@@ -411,6 +423,7 @@ Complete internal tool template built with Material UI. Features authentication
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-material-ui-template.png",
     ],
     runOnYourLocalPath: "auth-material-ui",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-material-ui",
     github:
@@ -431,6 +444,7 @@ Complete internal tool template built with Material UI. Features authentication
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-mantine-template.png",
     ],
     runOnYourLocalPath: "auth-mantine",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-mantine",
     github:
@@ -451,6 +465,7 @@ Complete internal tool template built with Mantine. Features authentication and
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-chakra-ui-template.png",
     ],
     runOnYourLocalPath: "auth-chakra-ui",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-chakra-ui",
     github:

diff --git a/documentation/plugins/templates.ts b/documentation/plugins/templates.ts
@@ -38,9 +38,10 @@ const templates = [
     images: [
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-refine-crm.png",
     ],
-    runOnYourLocalPath: "app-crm",
+    runOnYourLocalPath: null,
+    edition: "Enterprise",
     liveDemo: "https://example.crm.refine.dev/",
-    github: "https://github.com/refinedev/refine/tree/master/examples/app-crm",
+    github: null,
     reactPlatform: "Vite",
     uiFramework: "Ant Design",
     dataProvider: "Nestjs-query",
@@ -95,6 +96,7 @@ This CRM app template can be used in for various app requirements like B2B appli
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-storefront.png",
     ],
     runOnYourLocalPath: "finefoods-client",
+    edition: "Community",
     liveDemo: "https://example.refine.dev/",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-client",
@@ -103,6 +105,7 @@ This CRM app template can be used in for various app requirements like B2B appli
     dataProvider: "Rest API",
     authProvider: "Custom",
     description: `
+
 This is a template that can serve as an example for building React-based storefronts, admin panels, or internal tools using Refine. Implemented popular tools like Tailwind CSS and Next.js, which are highly demanded by the community.
 
 ### Key Features:
@@ -120,6 +123,7 @@ The source code is also open-source; feel free to use or inspect it to discover
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-finefoods-material-ui.png",
     ],
     runOnYourLocalPath: "finefoods-material-ui",
+    edition: "Community",
     liveDemo: "https://example.mui.admin.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-material-ui",
@@ -170,6 +174,7 @@ This admin panel template can be used in for various app requirements like B2B a
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-finefoods-ant-design.png",
     ],
     runOnYourLocalPath: "finefoods-antd",
+    edition: "Community",
     liveDemo: "https://example.admin.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/finefoods-antd",
@@ -222,6 +227,7 @@ This admin panel template can be used in for various app requirements like B2B a
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-store.png",
     ],
     runOnYourLocalPath: "store",
+    edition: "Community",
     liveDemo: "https://store.refine.dev/",
     github: "https://github.com/refinedev/refine/tree/master/examples/store",
     reactPlatform: "Next.js",
@@ -255,6 +261,7 @@ With its production-ready status, this template offers a solid foundation for bu
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-pixels.png",
     ],
     runOnYourLocalPath: "pixels",
+    edition: "Community",
     liveDemo: "https://pixels.refine.dev/",
     github: "https://github.com/refinedev/refine/tree/master/examples/pixels",
     tutorial: "https://refine.dev/week-of-refine-supabase/",
@@ -285,6 +292,7 @@ We built this template to demonstrate how the Refine framework simplifies and sp
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-invoice-generator.png",
     ],
     runOnYourLocalPath: "invoicer",
+    edition: "Community",
     liveDemo: "https://refine-invoicer-8mk7d.ondigitalocean.app/",
     github: "https://github.com/refinedev/refine/tree/master/examples/invoicer",
     reactPlatform: "Vite",
@@ -314,6 +322,7 @@ We built this template to showcase the efficiency and ease of using the Refine f
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/video-club-win95.png",
     ],
     runOnYourLocalPath: "win95",
+    edition: "Community",
     liveDemo: "https://videoclub.refine.dev",
     github: "https://github.com/refinedev/refine/tree/master/examples/win95",
     reactPlatform: "Vite",
@@ -333,6 +342,7 @@ The source code of the CRUD app is also open-source; feel free to use or inspect
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-realworld.png",
     ],
     runOnYourLocalPath: "real-world-example",
+    edition: "Community",
     liveDemo: "https://refine-real-world.netlify.app/",
     github: "https://github.com/refinedev/real-world-example",
     reactPlatform: "Vite",
@@ -366,6 +376,7 @@ Since the source code of this RealWorld app is open-source, you have the freedom
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-multitenancy-strapi.png",
     ],
     runOnYourLocalPath: "multi-tenancy-strapi",
+    edition: "Community",
     liveDemo: "https://multi-tenancy-strapi.refine.dev",
     github:
       "https://github.com/refinedev/refine/tree/master/examples/multi-tenancy-strapi",
@@ -389,6 +400,7 @@ The source code of this multitenancy app is open-source, allowing you to use or
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-ant-design-template.png",
     ],
     runOnYourLocalPath: "auth-antd",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/p/sandbox/github/refinedev/refine/tree/master/examples/auth-antd",
     github:
@@ -409,6 +421,7 @@ Complete internal tool template built with Material UI. Features authentication
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-material-ui-template.png",
     ],
     runOnYourLocalPath: "auth-material-ui",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-material-ui",
     github:
@@ -429,6 +442,7 @@ Complete internal tool template built with Material UI. Features authentication
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-mantine-template.png",
     ],
     runOnYourLocalPath: "auth-mantine",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-mantine",
     github:
@@ -449,6 +463,7 @@ Complete internal tool template built with Mantine. Features authentication and
       "https://refine.ams3.cdn.digitaloceanspaces.com/templates/detail-chakra-ui-template.png",
     ],
     runOnYourLocalPath: "auth-chakra-ui",
+    edition: "Community",
     liveDemo:
       "https://codesandbox.io/embed/github/refinedev/refine/tree/master/examples/auth-chakra-ui",
     github: