Back to Refine

Refine v4 Quickstart | Build a React App in 5 Minutes

documentation/versioned_docs/version-4.xx.xx/getting-started/quickstart.md

3.25.01.7 KB
Original Source

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { Playground } from "@site/src/components/playground";

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.

Using CLI

Use create-refine-app to quickly bootstrap a new Refine project with lots of options to fit your needs.

sh
npm create refine-app@latest
<figure>
<figcaption className="text-center">A Refine app created with CLI using Vite + Material UI + REST API + Custom Auth Provider</figcaption>
</figure>

Using Browser

Refine's browser-based scaffolder has the same set of options as the CLI-based scaffolder. It is a great way to set up a new project and have a preview of how it looks before you download it.

<Playground />

Next Steps

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

šŸ‘‰ See real-life examples built using Refine

šŸ‘‰ Check out the General Concepts and Data Fetching guides to start learning Refine.