Skip to content

Commit 013ee84

Browse files
committed
Updated readme with components to do
1 parent 044658a commit 013ee84

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
[![Build Status](https://travis-ci.org/ctidigital/magento2-configurator.svg?branch=develop)](https://travis-ci.org/ctidigital/magento2-configurator)
44

5+
6+
A Magento module initially created by [CTI Digital] to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:
7+
8+
- Install Magento from scratch with important database based configuration ready.
9+
- Share and collaborate configuration with other colleagues using your own versioning system.
10+
- Keep versions of your configurations using your own versioning system.
11+
- Split your configuration based on the environment you're developing on.
12+
13+
If you're interested about finding out more about the background of the configurator, watch this lightning talk by [Rick Steckles] at Mage Titans in Manchester on [YouTube].
14+
515
This is a work in progress and by no means for use with production environments (and probably not even development environments either just yet).
616

717
## Testing Locally For Development
@@ -12,4 +22,43 @@ php vendor/bin/phpcs --standard=PSR2 vendor/ctidigital/magento2-configurator/Mod
1222
php vendor/bin/phpmd vendor/ctidigital/magento2-configurator/Model/,vendor/ctidigital/magento2-configurator/Console/,vendor/ctidigital/magento2-configurator/Test/ text cleancode,codesize,controversial,design,naming,unusedcode
1323
php vendor/bin/phpcpd vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console vendor/ctidigital/magento2-configurator/Test/
1424
php vendor/bin/phpunit --coverage-clover build/logs/clover.xml vendor/ctidigital/magento2-configurator/Test/Unit/
15-
```
25+
```
26+
27+
## Roadmap for components to do
28+
29+
| Component | Code Written | Tests Written | Sample Files |
30+
|---------------------------|--------------------|---------------|--------------------|
31+
| Websites | :white_check_mark: | :x: | :white_check_mark: |
32+
| System Configuration | :white_check_mark: | :x: | :white_check_mark: |
33+
| Attribute Sets | :x: | :x: | :x: |
34+
| Attributes | :x: | :x: | :x: |
35+
| Categories | :x: | :x: | :x: |
36+
| Products | :x: | :x: | :x: |
37+
| Admin Roles | :x: | :x: | :x: |
38+
| Admin Users | :x: | :x: | :x: |
39+
| Pages | :x: | :x: | :x: |
40+
| Static Blocks | :x: | :x: | :x: |
41+
| Customers | :x: | :x: | :x: |
42+
| Media | :x: | :x: | :x: |
43+
| Widgets | :x: | :x: | :x: |
44+
| Related Products | :x: | :x: | :x: |
45+
| SQL | :x: | :x: | :x: |
46+
| Customer Groups | :x: | :x: | :x: |
47+
| Tax Rules | :x: | :x: | :x: |
48+
| API Roles | :x: | :x: | :x: |
49+
| API Users | :x: | :x: | :x: |
50+
| Shipping Table Rates | :x: | :x: | :x: |
51+
| Catalog Price Rules | :x: | :x: | :x: |
52+
| Shopping Cart Price Rules | :x: | :x: | :x: |
53+
| Rewrites | :x: | :x: | :x: |
54+
| Orders | :x: | :x: | :x: |
55+
56+
License
57+
----
58+
59+
MIT
60+
61+
62+
[CTI Digital]:http://www.ctidigital.com/
63+
[YouTube]:https://www.youtube.com/watch?v=u9zHaX8G5_0
64+
[Rick Steckles]:https://twitter.com/rick_steckles

0 commit comments

Comments
 (0)