Refine•3y ago

how do i setup the refine project locally after cloning it

i am having problem to set up locally

kapa.ai•10/12/23, 7:35 AM

Hi @min2_dev. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base.

kapa.ai•10/12/23, 7:36 AM

----------------------
To set up a refine project locally, you need to follow these steps:

Prepare your development environment: Before you can create a refine app, you need to set up a development environment on your local machine. This includes installing a few tools that you will use to create your project, and run key commands to build, develop, and test your site. You will need a terminal (also known as a command line interface) to run commands and interact with your operating system. You can access the terminal through a local program of your operating system, such as Terminal (MacOS/Linux) or Command Prompt (Windows). You will also need to have Node.js installed. Node.js is a JavaScript runtime that allows developers to run JavaScript code outside of a web browser. It is required to run refine applications because it is a JavaScript-based tool. To check if you already have a compatible version of Node.js (v.16.0.0 or higher) installed, launch your terminal and type the following command:
```
node -v
```
```
node -v
```
. If you do not have a compatible version of Node.js installed, follow these instructions to install Node.js (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) via the terminal. In addition to a terminal, you will also need a code editor to write and edit your code. A code editor is a software application that allows you to write and edit code for various programming languages. This tutorial will use VS Code, but you can use any code editor that is compatible with your operating system. Some other popular code editors include Sublime Text, Atom and Eclipse. source (https://refine.dev/docs/tutorial/getting-started/prepare-env/)

kapa.ai•10/12/23, 7:36 AM

Create a new project: There are two possible ways to set up a refine project: manually or using superplate. Superplate is a CLI tool for bootstrapping a Typescript React project with refine integrated out of the box. The tool offers the option to set up a headless refine project or a project with third-party UI libraries such as Ant design and Material UI. You can use to set up a refine project. As a first step, navigate to a preferred folder on your computer and run the command below to initialise CLI installer: . The installer will prompt you to select your preference for the project. Select the following options to proceed. Next, into the newly created folder and run the following command to install React hook form extension package for refine: and . This package will let us access React hook form's perks in refine. Once the installation is done, run the following command to start the development server: . If your default browser doesn't automatically open the app after starting the server, open your browser and navigate to to view the app. source (https://refine.dev/blog/dynamic-forms-in-react-hook-form/)

If you're still having trouble, could you please provide more details about the specific issue you're encountering?
----------------------
Note: you can ask me a follow up question by @ mentioning me again

----------------------

kapa.ai•10/12/23, 7:36 AM

@923536598249902141 kapa.ai is still learning and improving, please let us know how it did by reacting below

brilliant-lime•10/12/23, 7:36 AM

Hello @min2_dev
what is your problem ? can you give me more detail please ?

you can follow our contrubuting guide
https://refine.dev/docs/contributing/#running-in-development-mode

Contributing | refine

We follow a code of conduct when participating in the community. Please read it before you make any contributions.

verbal-limeOP•10/12/23, 7:55 AM

thanks for your reply

verbal-limeOP•10/12/23, 7:55 AM

first i fork the repo and then clone it

verbal-limeOP•10/12/23, 7:56 AM

then i am in the project directory and the run

verbal-limeOP•10/12/23, 7:56 AM

1.npm install
2.npm run bootstrap:all
3.npm run build:all

verbal-limeOP•10/12/23, 7:57 AM

and i cant navigate from docs what to do

verbal-limeOP•10/12/23, 7:57 AM

if you can please help me i will be really grateful

brilliant-lime•10/12/23, 8:05 AM

are you trying to make development on docs ?

verbal-limeOP•10/12/23, 8:05 AM

no on the code

brilliant-lime•10/12/23, 8:06 AM

which package ?

verbal-limeOP•10/12/23, 8:13 AM

brilliant-lime•10/12/23, 8:45 AM

We have many examples with chakra ui. for example if you want to develop feature on "base-chakra-ui" example, you can follow this steps

this will start base-chakra-ui. after that you can navigate to "examples/base-chakra-ui" example from your editor and you can develop your feature.