Skip to main content
Version: 4.xx.xx

Quick Start Guide

refine works on any environment that can run React (incl. Vite, Next.js, Remix, and CRA(Legacy) etc.)

Although you could take the time to manually set up your environment and install the refine packages afterwards, the optimal way to get started with refine is using the Browser-based Scaffolder and CLI-based Scaffolder.

Choose one of the methods below to bootstrap a refine app:

This is an efficient tool that allows you to create refine app seamlessly in your browser.

You can choose the libraries and frameworks you want to work with, and the tool will generate a boilerplate code for you.

  1. Navigate to scaffolder and select libraries and frameworks you want to work with by using interactive UI.
  2. Download the generated project by clicking on the "Build & Download" button.
React admin panel

  1. Next, navigate to the project folder, install the dependencies, and then start your project.
> npm install

> npm run dev

Now, you can access the refine application at http://localhost:3000.

You will see the output as a table populated with blog_posts and category data with filtering, sorting, and pagination features.

Example result

Next Steps​

πŸ‘‰ Jump to Tutorials and continue your work to turn your example project into a full-blown CRUD application! πŸš€

πŸ‘‰ Read more on Advanced Tutorials for different usage scenarios.

πŸ‘‰ See real-life examples built using refine