You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

Encore Installation

Encore InstallationΒΆ

First, make sure you install Node.js and also the Yarn package manager.

Then, install Encore into your project with Yarn:

1
$ yarn add @symfony/webpack-encore --dev

Note

If you want to use npm instead of yarn:

1
$ npm install @symfony/webpack-encore --save-dev

Tip

If you are using Flex for your project, you can initialize your project for Encore via:

1
2
$ composer require encore
$ yarn install

This will create a webpack.config.js file, add the assets/ directory, and add node_modules/ to .gitignore.

This command creates (or modifies) a package.json file and downloads dependencies into a node_modules/ directory. When using Yarn, a file called yarn.lock is also created/updated. When using npm 5, a package-lock.json file is created/updated.

Tip

You should commit package.json and yarn.lock (or package-lock.json if using npm 5) to version control, but ignore node_modules/.

Next, create your webpack.config.js in First Example!

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.