### Run the example application Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-08-19-heroicons.md Install project dependencies and start the local development server for the provided example repository. ```bash npm install npm run start ``` -------------------------------- ### Setup and Run Demo React Application Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-11-08-react-usereducer.md Use these commands to clone the repository, install dependencies, and start the development server for the demo application. ```bash cd hooks-user npm install npm run start ``` -------------------------------- ### Recommended Refine project setup options Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-11-05-recharts.md These selections guide the Refine CLI during project initialization to set up a basic application with Material UI and example pages, using npm as the package manager. ```txt ✔ Choose a project template · Vite ✔ What would you like to name your project?: · refine-recharts-demo ✔ Choose your backend service to connect: · REST API ✔ Do you want to use a UI Framework?: · Material UI ✔ Do you want to add example pages?: · Yes ✔ Do you need any Authentication logic?: · No ✔ Choose a package manager: · npm ``` -------------------------------- ### Install Refine Chakra UI Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/tutorial-chakra-ui/README.md Use this command to create a new Refine project pre-configured with the Chakra UI tutorial example on your local machine. ```bash npm create refine-app@latest -- --example tutorial-chakra-ui ``` -------------------------------- ### Install React Hook Form and Start Development Server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2022-03-29-react-hook-form-upload.md These commands navigate into the newly created React project, install the react-hook-form library, and then start the development server. ```bash cd react-hook-form-multipart-upload npm install react-hook-form npm run start ``` -------------------------------- ### Install Refine App Dependencies and Start Server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-08-20-react-hot-toast.md After downloading and extracting your Refine project, use these commands to install the necessary dependencies and launch the development server. ```bash // Install dependencies npm install // Start development server npm run dev ``` -------------------------------- ### Install Express for Server Setup Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2022-03-29-react-hook-form-upload.md Use this command to install the Express framework, which is essential for building the backend server. ```bash npm i express ``` -------------------------------- ### Install Dependencies and Start Development Server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-08-04-react-tooltip.md Execute these commands in your terminal to install project dependencies and launch the development server for a Refine application. ```bash npm install npm run dev ``` -------------------------------- ### Initialize refine App with Chakra UI Form Example Source: https://github.com/refinedev/refine/blob/main/examples/form-chakra-ui-use-form/README.md Use this command to create a new refine project pre-configured with the Chakra UI form example, allowing for quick local setup. ```bash npm create refine-app@latest -- --example form-chakra-ui-use-form ``` -------------------------------- ### Initialize Refine App with Hasura Data Provider Example Source: https://github.com/refinedev/refine/blob/main/examples/data-provider-hasura/README.md Use this command to create a new Refine project pre-configured with the Hasura data provider example, allowing for quick local setup. ```bash npm create refine-app@latest -- --example data-provider-hasura ``` -------------------------------- ### Starting a Bash Script with getopts Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-02-22-bash-script.md Initial setup for a bash script that will use the `getopts` utility to parse command-line flags and options. ```bash #!/bin/bash ``` -------------------------------- ### Create Refine App with Multi-level Menu Example using npm Source: https://github.com/refinedev/refine/blob/main/examples/multi-level-menu/README.md Use this command to initialize a new Refine project with the multi-level menu example pre-configured. Run it in your terminal to get started locally. ```bash npm create refine-app@latest -- --example multi-level-menu ``` -------------------------------- ### Initialize Refine App with Blog Heroicons Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/blog-heroicons-example/README.md Use this command to create a new Refine project on your local machine, pre-configured with the blog-heroicons-example. ```bash npm create refine-app@latest -- --example blog-heroicons-example ``` -------------------------------- ### Initialize Refine App with Web3 Example Source: https://github.com/refinedev/refine/blob/main/examples/with-web3/README.md Use this command to scaffold a new Refine project pre-configured with the `with-web3` example on your local machine. ```bash npm create refine-app@latest -- --example with-web3 ``` -------------------------------- ### Install Refine CLI Package Source: https://github.com/refinedev/refine/blob/main/documentation/tutorial/next-steps/cli/react-router/ant-design/index.md Use this command to install the `@refinedev/cli` package if it was not installed during the initial setup. ```bash npm install @refinedev/cli ``` -------------------------------- ### Initialize Refine App with Customization Footer Example Source: https://github.com/refinedev/refine/blob/main/examples/customization-footer/README.md Use this command to create a new Refine project pre-configured with the customization footer example. ```bash npm create refine-app@latest -- --example customization-footer ``` -------------------------------- ### Create refine-app with blog-refine-markdown example Source: https://github.com/refinedev/refine/blob/main/examples/blog-refine-markdown/README.MD Use this command to initialize a new refine project pre-configured with the `blog-refine-markdown` example on your local machine. ```bash npm create refine-app@latest -- --example blog-refine-markdown ``` -------------------------------- ### Initialize Refine App with Chakra UI Blog Tutorial Example Source: https://github.com/refinedev/refine/blob/main/examples/blog-ra-chakra-tutorial/README.MD Use this command to create a new Refine project pre-configured with the blog-ra-chakra-tutorial example, including Chakra UI integration. ```bash npm create refine-app@latest -- --example blog-ra-chakra-tutorial ``` -------------------------------- ### Navigate to Project and Start Development Server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2022-09-22-refine-supabase-auth.md Change into the newly created project directory and launch the development server to run the Refine application. ```bash cd refine-supabase-auth npm run dev ``` -------------------------------- ### Initialize Playwright Project Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-06-04-playwright.md Use this command to start the Playwright installation process, which includes setting up the project and installing browsers. ```bash npm init playwright@latest ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-07-19-use-swr.md Commands to install `styled-components` and `swr` packages using either `npm` or `yarn` for the example application. ```bash npm install styled-components swr ``` ```bash yarn add styled-components swr ``` -------------------------------- ### Run refine-mui Blog Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/blog-refine-mui/README.MD Use this command to initialize a new refine project with the `blog-refine-mui` example on your local machine. ```bash npm create refine-app@latest -- --example blog-refine-mui ``` -------------------------------- ### Install Vercel Command Line Tool Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-07-16-top-hosting.md Install the Vercel CLI globally for system-wide access or as a development dependency within your project. Global installation is assumed for subsequent examples. ```sh # Install globally npm install --global vercel ``` ```sh # Install as development dependency npm install --save-dev vercel ``` -------------------------------- ### Initialize Refine App with Top Menu Layout Example Source: https://github.com/refinedev/refine/blob/main/examples/customization-top-menu-layout/README.md Use this command to create a new Refine project pre-configured with the top menu layout customization example on your local machine. ```bash npm create refine-app@latest -- --example customization-top-menu-layout ``` -------------------------------- ### NVM Version Output Example Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-07-05-nvm.md This snippet shows an example of the output received when verifying the nvm installation, including version details and usage notes. ```bash Node Version Manager (v0.35.3) Note: refers to any version-like string nvm understands. This includes: - full or partial version numbers, starting with an optional "v" (0.10, v0.1.2, v1) - default (built-in) aliases: node, stable, unstable, iojs, system - custom aliases you define with `nvm alias foo` Any options that produce colorized output should respect the `--no-colors` option. ``` -------------------------------- ### Initialize Refine Finefoods Client Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/finefoods-client/README.md Use this command to create a new Refine project initialized with the finefoods-client example on your local machine. ```bash npm create refine-app@latest -- --example finefoods-client ``` -------------------------------- ### Next.js TypeScript Dependency Installation Output Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-06-10-next-typescript.md This output shows the automatic installation of required TypeScript packages by Next.js when `tsconfig.json` is present and the development server is started. ```bash It looks like you're trying to use TypeScript but do not have the required package(s) installed. Installing dependencies If you are not trying to use TypeScript, please remove the tsconfig.json file from your package root (and any TypeScript files in your pages directory). Installing devDependencies (yarn): - typescript - @types/react - @types/node [1/4] Resolving packages... [2/4] Fetching packages... ``` -------------------------------- ### Initialize refine blog-job-posting example locally Source: https://github.com/refinedev/refine/blob/main/examples/blog-job-posting/README.md Use this command to create a new refine application with the blog-job-posting example pre-configured on your local machine. ```bash npm create refine-app@latest -- --example blog-job-posting ``` -------------------------------- ### Run Refine Customization Login Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/customization-login/README.md Use this command to initialize a new Refine project with the `customization-login` example, setting up the necessary files and dependencies on your local machine. ```bash npm create refine-app@latest -- --example customization-login ``` -------------------------------- ### Install dependencies and start the React development server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-10-17-nextjs-vs-react.md Run this command within your React project directory to install necessary packages and launch the local development server. ```bash npm install && npm start ``` -------------------------------- ### Create refine App with Google Login Example Source: https://github.com/refinedev/refine/blob/main/examples/auth-google-login/README.md Use this command to initialize a new refine project pre-configured with the Google Login authentication example. ```bash npm create refine-app@latest -- --example auth-google-login ``` -------------------------------- ### Install Refine Mantine Integration and Dependencies Source: https://github.com/refinedev/refine/blob/main/packages/mantine/README.md This command installs the `@refinedev/mantine` package along with necessary Mantine UI components and related Refine packages for a complete setup. ```sh npm install @refinedev/mantine @refinedev/react-table @mantine/core@5 @mantine/hooks@5 @mantine/form@5 @mantine/notifications@5 @emotion/react @tabler/icons ``` -------------------------------- ### Initialize Refine App with Blog React Toastify Example Source: https://github.com/refinedev/refine/blob/main/examples/blog-react-toastify/README.MD Use this command to create a new Refine project pre-configured with the blog-react-toastify example on your local machine. ```bash npm create refine-app@latest -- --example blog-react-toastify ``` -------------------------------- ### Navigate and Start Refine Development Server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2021-10-4-admin-panel-with-nestjs.md Change into the newly created 'admin' project directory and start the development server. ```bash cd admin npm run dev ``` -------------------------------- ### Full example of CloneButton with hideText prop and routing Source: https://github.com/refinedev/refine/blob/main/documentation/docs/ui-integrations/ant-design/components/buttons/clone-button/index.md This example demonstrates a `CloneButton` with `hideText` enabled within a full routing setup, showing its appearance and navigation behavior. ```tsx setInitialRoutes(["/posts"]); // visible-block-start import { CloneButton } from "@refinedev/antd"; const MyCloneComponent = () => { return ( ); }; // visible-block-end const ClonedPage = () => { const parsed = RefineCore.useParsed(); return
{JSON.stringify(parsed, null, 2)}
; }; render( } > } /> } /> , ); ``` -------------------------------- ### Install Refine Remix Material UI Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/with-remix-material-ui/README.md Use this command to create a new Refine project based on the Remix with Material UI example on your local machine. ```bash npm create refine-app@latest -- --example with-remix-material-ui ``` -------------------------------- ### Run Refine Live Provider Ably Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/live-provider-ably/README.md Use this command to create a new Refine project pre-configured with the `live-provider-ably` example on your local machine. ```bash npm create refine-app@latest -- --example live-provider-ably ``` -------------------------------- ### Start Development Watch Mode for Refine Packages Source: https://github.com/refinedev/refine/blob/main/documentation/docs/guides-concepts/contributing/index.md Starts development watch mode for specified Refine packages and examples. Changes made will trigger recompilation and update in the browser. ```sh pnpm dev --scope @refinedev/antd --scope base-antd ``` -------------------------------- ### Create Refine App with Auth0 Example Source: https://github.com/refinedev/refine/blob/main/examples/auth-auth0/README.md Use this command to initialize a new Refine project pre-configured with the Auth0 authentication example. ```bash npm create refine-app@latest -- --example auth-auth0 ``` -------------------------------- ### Initialize Refine Project with Mantine useStepsForm Example Source: https://github.com/refinedev/refine/blob/main/examples/form-mantine-use-steps-form/README.md Use this command to create a new Refine project pre-configured with the Mantine useStepsForm example, allowing for quick local setup. ```bash npm create refine-app@latest -- --example form-mantine-use-steps-form ``` -------------------------------- ### Run Refine useInfiniteList Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/use-infinite-list/README.md Use this command to create a new Refine project pre-configured with the `useInfiniteList` example on your local machine. ```bash npm create refine-app@latest -- --example use-infinite-list ``` -------------------------------- ### REST API GET Request for Book Search Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-09-24-grpc-vs-rest.md An example HTTP GET request to search for a book by title, demonstrating URL encoding for query parameters and the Host header. ```tsx GET /api/books?title=Lord%20of%20the%20Rings HTTP/1.1 Host: book-database-service.com ``` -------------------------------- ### Example Output of Docker Compose Up Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-02-12-docker-cheat-sheet.md This output shows the status of services as they are started by `docker-compose up`. ```bash Starting db ... done Starting web ... done ``` -------------------------------- ### Opening a Refine Tutorial Example in StackBlitz Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-11-11-online-ide.md This example demonstrates how to open a specific Refine tutorial project from GitHub in StackBlitz, including query parameters for view settings. ```txt https://www.stackblitz.com/github/refinedev/refine/tree/main/examples/tutorial-antd?view=preview&theme=dark&codemirror=1 ``` -------------------------------- ### Initialize Refine App with Custom Pages Example (Bash) Source: https://github.com/refinedev/refine/blob/main/examples/with-custom-pages/README.md Use this command to quickly set up a new Refine project locally, pre-configured with the 'with-custom-pages' example. ```bash npm create refine-app@latest -- --example with-custom-pages ``` -------------------------------- ### Initialize Refine App with Ant Design Table Example Source: https://github.com/refinedev/refine/blob/main/examples/table-antd-use-table/README.md Use this command to create a new Refine project pre-configured with the `table-antd-use-table` example. This allows for quick local setup and development. ```bash npm create refine-app@latest -- --example table-antd-use-table ``` -------------------------------- ### Initialize Refine App with Kinde Auth Example Source: https://github.com/refinedev/refine/blob/main/examples/auth-kinde/README.md Use this command to create a new Refine project pre-configured with the Kinde authentication example on your local machine. ```bash npm create refine-app@latest -- --example auth-kinde ``` -------------------------------- ### Create Refine App with Mantine useForm Example Source: https://github.com/refinedev/refine/blob/main/examples/form-mantine-use-form/README.md Use this command to initialize a new Refine project pre-configured with the Mantine useForm example, enabling quick local setup and development. ```bash npm create refine-app@latest -- --example form-mantine-use-form ``` -------------------------------- ### Run Refine Customization Offlayout Area Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/customization-offlayout-area/README.md Use this command to create a new Refine project based on the `customization-offlayout-area` example, setting it up for local development. ```bash npm create refine-app@latest -- --example customization-offlayout-area ``` -------------------------------- ### Install Refine Packages Manually Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2022-03-16-internal-tool-frameworks.md Install the core Refine packages and Ant Design integration using npm. This is an alternative to using the Refine Project Creator CLI for project setup. ```bash npm i @refinedev/core @refinedev/antd ``` -------------------------------- ### Navigate and start Refine development server Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2023-01-23-redwood-vs-refine.md Change into the newly created Refine project directory and start the local development server. ```bash cd crud-refine ``` ```bash npm run dev ``` -------------------------------- ### Install Snowpack as Dev Dependency (npm) Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-06-21-temporal-api.md Adds Snowpack as a development dependency for the project setup. ```bash npm install --save-dev snowpack ``` -------------------------------- ### Create Refine App with CRM Minimal Example Source: https://github.com/refinedev/refine/blob/main/examples/app-crm-minimal/README.MD Use this command to scaffold a new Refine project based on the minimal CRM example, which automatically downloads files and installs necessary dependencies. ```bash npm create refine-app@latest -- --example app-crm-minimal ``` -------------------------------- ### Initialize Refine App with core-use-modal Example (Bash) Source: https://github.com/refinedev/refine/blob/main/examples/core-use-modal/README.md Use this command to create a new Refine project pre-configured with the `core-use-modal` example on your local machine. ```bash npm create refine-app@latest -- --example core-use-modal ``` -------------------------------- ### Initialize Refine App with Keycloak Example Source: https://github.com/refinedev/refine/blob/main/examples/auth-keycloak/README.md Use this command to create a new Refine project pre-configured with the Keycloak authentication example, allowing you to run it locally. ```bash npm create refine-app@latest -- --example auth-keycloak ``` -------------------------------- ### Full example of CloneButton with resource and recordItemId routing Source: https://github.com/refinedev/refine/blob/main/documentation/docs/ui-integrations/ant-design/components/buttons/clone-button/index.md This comprehensive example shows the `CloneButton` integrated within a React Router setup, demonstrating how it triggers navigation to a resource's clone route. ```tsx setInitialRoutes(["/categories"]); // visible-block-start import { CloneButton } from "@refinedev/antd"; const MyCloneComponent = () => { return ; }; // visible-block-end const CategoryClone = () => { const parsed = RefineCore.useParsed(); return
{JSON.stringify(parsed, null, 2)}
; }; render( } /> } /> , ); ``` -------------------------------- ### Initialize Refine App with Auth OTP Example Locally Source: https://github.com/refinedev/refine/blob/main/examples/auth-otp/README.md Use this command to create a new Refine project pre-configured with the Auth OTP example, ready to run on your local development environment. ```bash npm create refine-app@latest -- --example auth-otp ``` -------------------------------- ### Implement Date Range Selection with Two React DatePickers Source: https://github.com/refinedev/refine/blob/main/documentation/blog/2024-11-12-react-date-picker.md This example demonstrates using two `DatePicker` components to select a start and end date, ensuring the end date cannot precede the start date. ```tsx import React, { useState } from "react"; import DatePicker from "react-datepicker"; export default function App() { const [date, setDate] = useState(new Date()); const [startDate, setStartDate] = useState(); const [endDate, setEndDate] = useState(); return (
setStartDate(date)} startDate={startDate} /> setEndDate(date)} endDate={endDate} startDate={startDate} minDate={startDate} />
); } ```