-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Merge all Encore installation articles into a single one #10815
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,133 @@ | ||
Installing Encore (with Symfony Flex) | ||
===================================== | ||
Installing Encore | ||
================= | ||
|
||
.. tip:: | ||
First, make sure you `install Node.js`_ and also the `Yarn package manager`_. | ||
The following instructions depend on whether you are installing Encore in a | ||
Symfony application or not. | ||
|
||
If your project does **not** use Symfony Flex, read :doc:`/frontend/encore/installation-no-flex`. | ||
Installing Encore in Symfony Applications | ||
----------------------------------------- | ||
|
||
First, make sure you `install Node.js`_ and also the `Yarn package manager`_. Then | ||
run: | ||
If your application is using :doc:`Symfony Flex </setup/flex>`, run the | ||
following commands: | ||
|
||
.. code-block:: terminal | ||
|
||
$ composer require encore | ||
$ yarn install | ||
|
||
This will create a ``webpack.config.js`` file, add the ``assets/`` directory, and | ||
add ``node_modules/`` to ``.gitignore``. | ||
This will install and enable the `WebpackEncoreBundle`_, add the ``assets/`` | ||
directory, create a ``webpack.config.js`` file, and add ``node_modules/`` to | ||
``.gitignore``. If you are not using Symfony Flex, you'll need to create all | ||
this by yourself following the instructions shown in the next section. | ||
|
||
Nice work! You can skip the rest of this article and go write your first | ||
JavaScript and CSS by reading :doc:`/frontend/encore/simple-example`! | ||
|
||
Installing Encore in non Symfony Applications | ||
--------------------------------------------- | ||
|
||
Install Encore into your project via Yarn: | ||
|
||
.. code-block:: terminal | ||
|
||
$ yarn add @symfony/webpack-encore --dev | ||
|
||
# if you prefer npm, run this command instead: | ||
# npm install @symfony/webpack-encore --save-dev | ||
|
||
This command creates (or modifies) a ``package.json`` file and downloads | ||
dependencies into a ``node_modules/`` directory. Yarn also creates/updates a | ||
``yarn.lock`` (called ``package-lock.json`` if you use npm). | ||
|
||
.. tip:: | ||
|
||
You *should* commit ``package.json`` and ``yarn.lock`` (or ``package-lock.json`` | ||
if using npm) to version control, but ignore ``node_modules/``. | ||
|
||
Creating the webpack.config.js File | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Next, create a new ``webpack.config.js`` file at the root of your project. This | ||
is the main config file for both Webpack and Webpack Encore: | ||
|
||
.. code-block:: js | ||
|
||
var Encore = require('@symfony/webpack-encore'); | ||
|
||
Encore | ||
// directory where compiled assets will be stored | ||
.setOutputPath('web/build/') | ||
// public path used by the web server to access the output path | ||
.setPublicPath('/build') | ||
// only needed for CDN's or sub-directory deploy | ||
//.setManifestKeyPrefix('build/') | ||
|
||
/* | ||
* ENTRY CONFIG | ||
* | ||
* Add 1 entry for each "page" of your app | ||
* (including one that's included on every page - e.g. "app") | ||
* | ||
* Each entry will result in one JavaScript file (e.g. app.js) | ||
* and one CSS file (e.g. app.css) if you JavaScript imports CSS. | ||
*/ | ||
.addEntry('app', './assets/js/app.js') | ||
//.addEntry('page1', './assets/js/page1.js') | ||
//.addEntry('page2', './assets/js/page2.js') | ||
|
||
// will require an extra script tag for runtime.js | ||
// but, you probably want this, unless you're building a single-page app | ||
.enableSingleRuntimeChunk() | ||
|
||
.cleanupOutputBeforeBuild() | ||
.enableSourceMaps(!Encore.isProduction()) | ||
// enables hashed filenames (e.g. app.abc123.css) | ||
.enableVersioning(Encore.isProduction()) | ||
|
||
// uncomment if you use TypeScript | ||
//.enableTypeScriptLoader() | ||
|
||
// uncomment if you use Sass/SCSS files | ||
//.enableSassLoader() | ||
|
||
// uncomment if you're having problems with a jQuery plugin | ||
//.autoProvidejQuery() | ||
; | ||
|
||
module.exports = Encore.getWebpackConfig(); | ||
|
||
Next, create a new ``assets/js/app.js`` file with some basic JavaScript *and* | ||
import some JavaScript: | ||
|
||
.. code-block:: javascript | ||
|
||
// assets/js/app.js | ||
|
||
require('../css/app.css'); | ||
|
||
console.log('Hello Webpack Encore'); | ||
|
||
And the new ``assets/css/app.css`` file: | ||
|
||
.. code-block:: css | ||
|
||
/* assets/css/app.css */ | ||
body { | ||
background-color: lightgray; | ||
} | ||
|
||
You'll customize and learn more about these file in :doc:`/frontend/encore/simple-example`. | ||
|
||
.. caution:: | ||
|
||
Nice work! Write your first JavaScript and CSS by reading :doc:`/frontend/encore/simple-example`! | ||
Some of the documentation will use features that are specific to Symfony or | ||
Symfony's `WebpackEncoreBundle`_. These are optional, and are special ways | ||
of pointing to the asset paths generated by Encore that enable features like | ||
:doc:`versioning </frontend/encore/versioning>` and | ||
:doc:`split chunks </frontend/encore/split-chunks>`. | ||
|
||
.. _`install Node.js`: https://nodejs.org/en/download/ | ||
.. _`Yarn package manager`: https://yarnpkg.com/lang/en/docs/install/ | ||
.. _`npm`: https://www.npmjs.com/ | ||
.. _`WebpackEncoreBundle`: https://github.com/symfony/webpack-encore-bundle |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’m cool with this - a bit awkward - but can’t think of anything much better