This is a Next.js application with vinext as the default local development server.
The required Node.js and pnpm versions are pinned by the repository root devEngines.runtime and packageManager fields. Vite+ is also available for repository checks and tests; use its official documentation as the installation reference.
Run the following commands from the repository root.
First, install the dependencies:
pnpm installThen, configure the environment variables.
Create web/.env.local and copy the contents from web/.env.example.
Modify the values of these environment variables according to your requirements:
cp web/.env.example web/.env.localImportant
- When the frontend and backend run on different subdomains, set NEXT_PUBLIC_COOKIE_DOMAIN=1. The frontend and backend must be under the same top-level domain in order to share authentication cookies.
- It's necessary to set NEXT_PUBLIC_API_PREFIX and NEXT_PUBLIC_PUBLIC_API_PREFIX to the correct backend API URL.
Finally, start the default development stack from the repository root. This runs vinext and the local API proxy together:
pnpm devUse pnpm -C web dev only when you specifically need the Next.js development server without the default vinext process. Proxy environment variables are documented in web/.env.example; route ownership remains in web/dev-proxy.config.ts.
Open http://localhost:3000 with your browser to see the result.
You can start editing the files under web/app.
The page auto-updates as you edit the file.
The workspace catalog pins vinext to 1.0.0-beta.13. Following the
versioned vinext guide, dev:vinext and build:vinext use the project-local
Vite+ CLI (vp dev / vp build); the vinext plugin owns the development and multi-environment build
lifecycle. Keep the Next.js scripts available for compatibility comparisons.
When upgrading, run the installed compatibility scanner and verify the application:
pnpm -C web exec vinext check
pnpm -C web run build:vinext
pnpm -C web run start:vinextThe scanner is a starting point; also check sign-in, redirects, and the workflows affected by the upgrade. See the vinext migration guide for validation guidance.
First, build the app for production:
pnpm -C web run buildThen, start the server:
pnpm -C web run startIf you build the Docker image manually, use the repository root as the build context:
docker build -f web/Dockerfile -t dify-web .If you want to customize the host and port:
PORT=3001 HOSTNAME=0.0.0.0 pnpm -C web run startpnpm -C web run build:vinext honors output: 'standalone' in next.config.ts
and emits web/dist/standalone. To run the self-contained production server:
HOST=0.0.0.0 PORT=3000 node web/dist/standalone/server.jsVinext uses HOST for the bind address; Next.js standalone uses HOSTNAME.
Use start:vinext for local production testing. See vinext Node deployment.
This project uses Storybook for UI component development.
To start the storybook server, run:
pnpm -C web storybookOpen http://localhost:6006 with your browser to see the result.
For VS Code, copy .vscode/settings.example.json to .vscode/settings.json, or merge it into your existing settings.
Then follow the Lint Documentation to lint the code.
We use Vitest and React Testing Library through Vite+. Run unit tests in happy-dom with:
cd web
vp test run --project unitSelect a project explicitly; bare vp test also runs Browser Mode. Use vp instead of the standalone vitest command. The Frontend Testing Guide owns test policy, Browser Mode admission, and diagnostic commands.
Visit https://docs.dify.ai to view the full documentation.
The Dify community can be found on Discord community, where you can ask questions, voice ideas, and share your projects.