A React Framework for building internal tools, admin panels, dashboards & B2B apps with unmatched flexibility.
Installations
npm install @refinedev/core
Developer Guide
Typescript
No
Module System
CommonJS, ESM
Node Version
18.20.5
NPM Version
10.8.2
Score
63.3
Supply Chain
94.1
Quality
93.3
Maintenance
100
Vulnerability
99.3
License
Releases
@refinedev/ui-tests@1.15.1
Published on 13 Dec 2024
@refinedev/ui-types@1.23.1
Published on 13 Dec 2024
@refinedev/supabase@5.9.6
Published on 13 Dec 2024
@refinedev/strapi-v4@6.0.11
Published on 13 Dec 2024
@refinedev/simple-rest@5.0.10
Published on 13 Dec 2024
@refinedev/strapi@4.1.14
Published on 13 Dec 2024
Contributors
Languages
TypeScript (97.62%)
JavaScript (2.09%)
CSS (0.16%)
HTML (0.08%)
Handlebars (0.05%)
Developer
Download Statistics
Total Downloads
1,466,115
Last Day
2,997
Last Week
25,237
Last Month
123,525
Last Year
1,165,410
GitHub Statistics
29,117 Stars
6,815 Commits
2,282 Forks
134 Watching
32 Branches
281 Contributors
Bundle Size
238.80 kB
Minified
67.51 kB
Minified + Gzipped
Package Meta Information
Latest Version
4.57.1
Package Id
@refinedev/core@4.57.1
Unpacked Size
3.84 MB
Size
776.69 kB
File Count
1,536
NPM Version
10.8.2
Node Version
18.20.5
Publised On
13 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
1,466,115
Last day
-48.9%
2,997
Compared to previous day
Last week
-18.5%
25,237
Compared to previous week
Last month
-4.9%
123,525
Compared to previous month
Last year
287.6%
1,165,410
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
9
Peer Dependencies
5
Dev Dependencies
22
Refine is as an open source, React meta-framework for enterprise. It provides a headless solution for everything from admin panels to dashboards and internal tools.
What is Refine?
Refine is a React meta-framework for CRUD-heavy web applications. It addresses a wide range of enterprise use cases including internal tools, admin panels, dashboards and B2B apps.
Refine's core hooks and components streamline the development process by offering industry-standard solutions for crucial aspects of a project, including authentication, access control, routing, networking, state management, and i18n.
Refine's headless architecture enables the building of highly customizable applications by decoupling business logic from UI and routing. This allows integration with:
-
Any custom designs or UI frameworks like TailwindCSS, along with built-in support for Ant Design, Material UI, Mantine, and Chakra UI.
-
Various platforms, including Next.js, Remix, React Native, Electron, etc., by a simple routing interface without the need for additional setup steps.
⚡ Try Refine
Start a new project with Refine in seconds using the following command:
1npm create refine-app@latest my-refine-app
Or you can create a new project on your browser:
Quick Start
Here's Refine in action, the below code is an example of a simple CRUD application using Refine + React Router + Material UI:
1import React from "react"; 2import { Refine, useMany } from "@refinedev/core"; 3import { ThemedLayoutV2 } from "@refinedev/mui"; 4import dataProvider from "@refinedev/simple-rest"; 5import routerProvider from "@refinedev/react-router"; 6import { BrowserRouter, Outlet, Route, Routes } from "react-router"; 7 8import CssBaseline from "@mui/material/CssBaseline"; 9 10export default function App() { 11 return ( 12 <BrowserRouter> 13 <CssBaseline /> 14 <Refine 15 dataProvider={dataProvider("https://api.fake-rest.refine.dev")} 16 routerProvider={routerProvider} 17 resources={[ 18 { 19 name: "products", 20 list: "/products", 21 }, 22 ]} 23 > 24 <Routes> 25 <Route 26 element={ 27 <ThemedLayoutV2> 28 <Outlet /> 29 </ThemedLayoutV2> 30 } 31 > 32 <Route path="/products"> 33 <Route index element={<ProductList />} /> 34 </Route> 35 </Route> 36 </Routes> 37 </Refine> 38 </BrowserRouter> 39 ); 40} 41 42// src/pages/products/list.tsx 43 44import { List, useDataGrid, DateField } from "@refinedev/mui"; 45import { DataGrid, GridColDef } from "@mui/x-data-grid"; 46 47export const ProductList = () => { 48 const { dataGridProps } = useDataGrid(); 49 50 const { data: categories, isLoading } = useMany({ 51 resource: "categories", 52 ids: 53 dataGridProps?.rows?.map((item) => item?.category?.id).filter(Boolean) ?? 54 [], 55 queryOptions: { 56 enabled: !!dataGridProps?.rows, 57 }, 58 }); 59 60 const columns = React.useMemo<GridColDef[]>( 61 () => [ 62 { field: "id", headerName: "ID", type: "number" }, 63 { field: "name", flex: 1, headerName: "Name" }, 64 { 65 field: "category", 66 flex: 1, 67 headerName: "Category", 68 display: "flex", 69 renderCell: ({ value }) => 70 isLoading 71 ? "Loading..." 72 : categories?.data?.find((item) => item.id === value?.id)?.title, 73 }, 74 { 75 field: "createdAt", 76 flex: 1, 77 headerName: "Created at", 78 display: "flex", 79 renderCell: ({ value }) => <DateField value={value} />, 80 }, 81 ], 82 [categories?.data, isLoading], 83 ); 84 85 return ( 86 <List> 87 <DataGrid {...dataGridProps} columns={columns} /> 88 </List> 89 ); 90};
The result will look like this:
Use cases
Refine shines on data-intensive⚡ enterprise B2B applications like admin panels, dashboards and internal tools. Thanks to the built-in SSR support, it can also power customer-facing applications like storefronts.
You can take a look at some live examples that can be built using Refine from scratch:
- Fully-functional CRM Application
- Fully-functional Admin Panel
- Win95 Style Admin panel 🪟
- PDF Invoice Generator
- Medium Clone - Real World Example
- Multitenancy Example
- Storefront
- Refer to templates page for more examples
- More Refine powered different usage scenarios can be found here
Key Features
- Refine Devtools - dive deeper into your app and provide useful insights
- Connectors for 15+ backend services including REST API, GraphQL, NestJs CRUD, Airtable, Strapi, Strapi v4, Supabase, Hasura, Appwrite, Nestjs-Query, Firebase, Sanity, and Directus.
- SSR support with Next.js & Remix and Advanced routing with any router library of your choice
- Auto-generation of CRUD UIs based on your API data structure
- Perfect state management & mutations with React Query
- Providers for seamless authentication and access control flows
- Out-of-the-box support for live / real-time applications
- Easy audit logs & document versioning
Learning Refine
- Navigate to the Tutorial on building comprehensive CRUD application guides you through each step of the process.
- Visit the Guides & Concepts to get informed about the fundamental concepts.
- Read more on Advanced Tutorials for different usage scenarios.
Contribution
Refer to the contribution docs for more information.
If you have any doubts related to the project or want to discuss something, then join our Discord server.
Contributors ♥️ Thanks
We extend our gratitude to all our numerous contributors who create plugins, assist with issues and pull requests, and respond to questions on Discord and GitHub Discussions.
Refine is a community-driven project, and your contributions continually improve it.
License
Licensed under the MIT License, Copyright © 2021-present Refinedev
No vulnerabilities found.
No security vulnerabilities found.