---
title: "快速开始"
locale: "zh"
version: "1.x"
canonicalUrl: "https://farmfe.org/zh/docs/1.x/quick-start"
publicationStatus: "prerelease"
---
# 快速开始
> [!NOTE]
> 备注
>
> Farm 需要 **Node 16.18.0 及更高版本**。
## 在线体验
[![Edit Farm]()]()
## 1. 创建一个 Farm 项目
**npm**
```sh
npm create farm@latest
```
**pnpm**
```sh
pnpm create farm@latest
```
**yarn**
```sh
yarn create farm@latest
```
**bun**
```sh
bun create farm@latest
```
> [!NOTE]
> 然后按照提示操作！
>
> 您还可以通过附加命令行选项直接指定项目名称和要使用的模板：
**npm**
```sh
npm create farm my-react-app --template react
```
**pnpm**
```sh
pnpm create farm my-react-app --template react
```
**yarn**
```sh
yarn create farm my-react-app --template react
```
**bun**
```sh
bun create farm my-react-app --template react
```
## 2.启动项目
选择您喜欢的包管理器，安装依赖项，然后启动项目。
**npm**
```sh
cd farm-project && npm i && npm start
```
**pnpm**
```sh
cd farm-project && pnpm i && pnpm start
```
**yarn**
```sh
cd farm-project && yarn i && yarn start
```
**bun**
```sh
cd farm-project && bun i && bun start
```
默认情况下，该项目将从` http://localhost:9000 `启动。
## 3. 配置项目
该项目由项目根目录中的“farm.config.ts/js/mjs”文件进行配置。
```ts
import { defineConfig } from "@farmfe/core";
export default defineConfig({
// 编译相关配置
compilation: {
input: {
// 可以配置相对或者绝对路径
index: "./index.html",
},
output: {
path: "./build",
publicPath: "/",
},
// ...
},
// Dev Server 相关配置
server: {
port: 9000,
// ...
},
// 插件配置
plugins: [],
});
```
> [!NOTE]
> 备注
>
> 配置详情请参阅 **[配置 Farm]()**。
## 4. 构建项目
将 Farm 项目构建为生产环境可用的静态文件：
```bash
npm run build
```
构建的产品默认降级为` ES2017 `，并且产品将被压缩和Tree Shake。 如果您想在本地预览构建产品，可以执行` npm run Preview `或` npx farm Preview `。
## 下一步
- [为什么需要 Farm？]()
- [特性]()
- [配置参考]()
- [插件]()
---