@@ -172,15 +172,15 @@ different `auth.json` file per project, move the `auth.json` file into your
172
172
project's home directory. Most people add this file to their ` .gitignore ` file
173
173
to help restrict access to the download keys.
174
174
175
- ** Existing Project**
175
+ ** Option 1: Existing Project**
176
176
177
177
If you have an existing project with all the source code already under
178
178
` shared/www ` on your laptop, no additional configuration is needed. If you use
179
179
volume mounting, the code will automatically be visible; if you use Unison,
180
180
Unison will copy files on your laptop into the web container when it is
181
181
started.
182
182
183
- ** Creating a New Project with Composer**
183
+ ** Option 2: Creating a New Project with Composer**
184
184
185
185
Log into the web container.
186
186
@@ -197,7 +197,7 @@ down Composer.)
197
197
composer create-project --repository=https://repo.magento.com/ magento/project-community-edition:2.1.8 .
198
198
chmod +x bin/magento
199
199
200
- ** Getting Code from a GitHub Project**
200
+ ** Option 3: Getting Code from a GitHub Project**
201
201
202
202
It is strongly recommended to saving your project code in a private git
203
203
repository on a hosting provider such as GitHub or BitBucket. The following
@@ -216,7 +216,7 @@ Check out the project from inside the container into the `magento2` directory.
216
216
xdebug-off
217
217
composer install
218
218
219
- ** Magento Commerce (Cloud)**
219
+ ** Option 4: Magento Commerce (Cloud)**
220
220
221
221
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
222
222
@@ -253,7 +253,7 @@ above. `magento-cloud build` runs the `composer install` and patching command,
253
253
but also runs additional commands (such as ` di-compile ` ) which you may not want
254
254
to run during development.
255
255
256
- ** Internal Development**
256
+ ** Option 5: Internal Development**
257
257
258
258
TODO: THIS SECTION IS INDICATIVE OF FUTURE DIRECTION, NOT SUPPORTED YET.
259
259
@@ -328,7 +328,7 @@ be added when the project was created above.
328
328
329
329
--amqp-virtualhost=/ --ampq-host=ampq --amqp-port=TODO --amqp-user=guest --amqp-password=guest
330
330
331
- ** Loading Optional Sample Data**
331
+ ** Loading Sample Data (Optional) **
332
332
333
333
To download the Luma sample data, you may need to provide Composer
334
334
authentication details. If you already have a ` ~/.composer/auth.json ` file you
@@ -353,7 +353,7 @@ purposes, but makes all PHP scripts slower to execute.
353
353
magento deploy:mode:set developer
354
354
xdebug-on
355
355
356
- ### 7. Start Unison, if Needed
356
+ ### 7. Start Unison (Mac, Windows)
357
357
358
358
If you are using Unison for file syncing, you also need to start up a Unison
359
359
process (and keep it running). It is generally recommended to start this up
@@ -379,7 +379,7 @@ Each time you log in, make sure you restart Unison, but be careful to not have
379
379
multiple copies running in parallel. It is not recommended to do significant
380
380
work on the project without Unison running to avoid merge conflicts (rare).
381
381
382
- ### 8. Cron
382
+ ### 8. Cron (Optional)
383
383
384
384
Cron is disabled by default. Running cron may result in faster draining of
385
385
laptop batteries. To manually trigger background index updates, run `magento
@@ -390,8 +390,6 @@ second cron to run).
390
390
magento cron:run
391
391
magento cron:run
392
392
393
- TODO: VERIFY TWO RUNS ARE NEEDED FIRST TIME ONLY. IF SO, CAN SIMPLIFY HERE.
394
-
395
393
To enable cron permanently run the following shell script.
396
394
397
395
cron-install
@@ -421,7 +419,7 @@ Be aware that in developer mode the slower PHP debug mode is on and missing
421
419
CSS and similar files are created on demand. This means the first time you
422
420
load a page you will see significantly longer load times.
423
421
424
- ### 10. Configure PHP Storm (if appropriate )
422
+ ### 10. Configure PHP Storm (Optional )
425
423
426
424
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
427
425
@@ -470,7 +468,7 @@ completed.
470
468
8 . Select "Tools" / "SSH Terminal", and select the "Default Remote
471
469
Interpreter" radio button.
472
470
473
- ### 11. Varnish Configuration
471
+ ### 11. Varnish Configuration (Optional)
474
472
475
473
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
476
474
@@ -490,7 +488,7 @@ number, use
490
488
491
489
docker-compose port varnish 6081
492
490
493
- ### 12. Redis Configuration
491
+ ### 12. Redis Configuration (Optional)
494
492
495
493
Uncomment the Redis service in the ` docker-compose.yml ` if you wish to use
496
494
Redis during development, keeping your local development environment closer to
@@ -516,7 +514,9 @@ To turn on usage of Redis for page caching (not needed if using Varnish), run
516
514
517
515
magento setup:config:set --page-cache=redis --page-cache-redis-server=redis --page-cache-redis-db=2
518
516
519
- ### 13. Grunt and Gulp Configuration
517
+ ### 13. ElasticSearch Configuration (Optional)
518
+ ### 14. ElasticSearch Configuration (Optional)
519
+ ### 15. Grunt and Gulp Configuration (Optional)
520
520
521
521
Grunt and Gulp are both frontend tool chains to speed up frontend development.
522
522
They can both auto-recompile CSS files as soon as a file is written to disk.
0 commit comments