PHPackages                             bdc/module-ordernotes - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. bdc/module-ordernotes

ActiveMagento2-module[Utility & Helpers](/categories/utility)

bdc/module-ordernotes
=====================

BDCrops OrderNotes module for Magento 2 extensions.

101PHP

Since Sep 22Pushed 6y ago2 watchersCompare

[ Source](https://github.com/bdcrops/module-ordernotes)[ Packagist](https://packagist.org/packages/bdc/module-ordernotes)[ RSS](/packages/bdc-module-ordernotes/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Magento2x OrderNotes
====================

[](#magento2x-ordernotes)

This module is used as a OrderNotes for Magento 2 extensions. we have built a small, but functional, order notes module. This allowed us to familiarize ourselves with an important aspect of customizing the checkout experience. The gist of this lies in understanding the checkout\_index\_index layout handle, the JavaScript window.checkoutConfig object, and the uiComponent.

Goal
----

[](#goal)

- Customizing & Passing data Checkout Experiences
- Adding order notes to the checkout
- Learn Magento 2 Certified Professional Developer exam topics "Customizing the Checkout Process 13%"

1. Install & upgrade OrderNotes
-----------------------------------

[](#1-install--upgrade--ordernotes)

#### 1.1 Copy and paste

[](#11-copy-and-paste)

If you don't want to install via composer, you can use this way.

- Download [the latest version here](https://github.com/bdcrops/module-ordernotes/archive/master.zip)
- Extract `master.zip` file to `app/code/BDC/OrderNotes` ; You should create a folder path `app/code/BDC/OrderNotes` if not exist.
- Go to Magento root folder and run upgrade command line to install `BDC_OrderNotes`:

```
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

```

#### 1.2 Install via composer

[](#12-install-via-composer)

We recommend you to install BDC\_OrderNotes module via composer. It is easy to install, update and maintaince.Run the following command in Magento 2 root folder.

```
composer config repositories.module-ordernotes git
https://github.com/bdcrops/module-ordernotes.git

composer require bdcrops/module-ordernotes:~1.0.0
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

```

#### 1.3 Upgrade

[](#13-upgrade)

```
composer update bdcrops/module-ordernotes
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

```

Run compile if your store in Product mode:

```
php bin/magento setup:di:compile

```

2. Magento 2 Module "OrderNotes" Step By Step Tutorial
------------------------------------------------------

[](#2-magento-2-module-ordernotes-step-by-step-tutorial)

- Create app/code/BDC/OrderNotes/registration.php

```

```

- Create app/code/BDC/OrderNotes/Setup/InstallSchema.php

```

```

- Create app/code/BDC/OrderNotes/Controller/Index.php

```

                BDC\OrderNotes\Model\ConfigProvider

```

- Create app/code/BDC/OrderNotes/Model/ConfigProvider.php

```

```

- Create app/code/BDC/OrderNotes/Observer/SaveOrderNotesToOrder.php

```