Launch the refine CLI setup
The easiest way to create a new project is to use the refine CLI. This tool will help you get started quickly by generating a new project with a basic configuration and a folder structure that follows best practices.
Launch your terminal and type the following command using your preferred package manager:
npm create refine-app@latest -- -o refine-headless tutorial
pnpm create refine-app@latest -- -o refine-headless tutorial
yarn create refine-app -- -o refine-headless tutorial
Only support yarn@1 version.
yto installation of
-o refine-headlessflag in the command above tells the CLI to install the project with the
refine-headlesspreset. This preset selects some options for you in accordance with this tutorial.
We use a preset here to sync the tutorial content with the code. Outside of the tutorial, you can skip this flag and select your own options.
The CLI will ask if you agree to share your selection anonymously with the refine team. You can choose whatever you prefer.
Once the installation wizard is finished, you can close this terminal window and open VS Code to continue your journey.
Open your project in VS Code
Open Visual Studio Code and select the directory that was generated during your setup process.
Make sure the terminal is open and ready to run commands. You can open it by pressing
Ctrl + J(Windows) or
Cmd ⌘ + J(macOS).
For the rest of this tutorial, you can use the terminal within VS Code instead of your computer's terminal.
Running the dev server
To preview your project as a web page while you work on it, the project must be running in development (dev) mode.
Start the dev server
To start the dev server, run the following command in your terminal:
npm run dev
pnpm run dev
yarn run dev
You should see confirmation in the terminal that the refine app is running in dev mode.
Viewing a preview of your app
Your project files contain all the code you need to run your website. To see a preview of your website in the browser:
Click on the localhost:3000 link in the terminal. This will open a new browser tab with your app running in dev mode.
You will be redirected to the welcome page as we have not added any pages yet.
(Next section will guide you through adding pages to your app.)
Here's what you should see: