Quick Start

Online experience

Create a Farm Project

npmyarnpnpmbun

sh

npm create farm@latest

sh

yarn create farm@latest

sh

pnpm create farm@latest

sh

bun create farm@latest

npmyarnpnpmbun

sh

npm create farm farm-app --template react

sh

yarn create farm farm-app --template react

sh

pnpm create farm farm-app --template react

sh

bun create farm farm-app --template react

2. Start the Project

Choose the package manager you like, install dependencies, then start the project. Then, start the project:

npmyarnpnpmbun

sh

cd farm-app && npm install && npm dev

sh

cd farm-app && yarn install && yarn dev

sh

cd farm-app && pnpm install && pnpm dev

sh

cd farm-app && bun install && bun dev

The project will start at http://localhost:9000 by default.

3. Configuring the Project

The project is configured by farm.config.ts/js/mjs file in the root directory of the project.

import { defineConfig } from "@farmfe/core";
import react from '@farmfe/plugin-react';

export default defineConfig({
  // Additional plugins
  plugins: [react()],
});

4. Building the project

Build the Farm project as production-ready static files:

npmyarnpnpmbun

sh

npm run build

sh

yarn run build

sh

pnpm run build

sh

bun run build

The built product is downgraded to ES2017 by default, and the product will be compressed and Tree Shake. If you want to preview the build product locally, you can execute npm run preview or npx farm preview.

4. Preview the build products

Start preview server

npmyarnpnpmbun

sh

npm run preview

sh

yarn run preview

sh

pnpm run preview

sh

bun run preview

Next Steps

• Why Farm?
• Features
• Configuring Farm
• Plugins