Skip to content

Commit e14819d

Browse files
authored
Merge pull request #17 from spryker-sdk/example-of-directories-structure
Updated README file with examples of directories structures
2 parents 037723d + af47b8b commit e14819d

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,32 @@ If you only need to add a new Spryk configuration you will start by adding an In
102102

103103
When this is done run the Integration tests with `vendor/bin/codecept run Integration -g {YOUR TEST GROUP}` and see the test failing. You will get a message that the Spryk definition was not found by the given name, so add the definition file for you new Spryk.
104104

105-
You need to add your Spryk definition file into `vendor/spryker-sdk/spryk/config/spryk/spryks` when you added your new Spryk definition file re-run the tests. Now it dependends on the spryk type you choosed for your Spryk definition what comes next.
105+
You need to add your Spryk definition file into `config/spryk/spryks/` on project or core level:
106106

107-
If you selected the template Spryk you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `vendor/spryker-sdk/spryk/config/spryk/templates` when this is done re-run your tests. Now you should see a green test.
107+
```
108+
project OR package root directory
109+
110+
└─── config/
111+
│ └─── spryk/
112+
│ │ └─── spryks/
113+
│ │ │ ...
114+
│ │ │ spryk-name.yml
115+
│ │ │ ...
116+
│ └─── ...
117+
```
118+
119+
If you selected the template Spryk, you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates/` on project or core level:
120+
121+
```
122+
project OR package root directory
123+
124+
└─── config/
125+
│ └─── spryk/
126+
│ │ └─── templates/
127+
│ │ │ ...
128+
│ │ │ template-name.twig
129+
│ │ │ ...
130+
│ └─── ...
131+
```
132+
133+
When this is done re-run your tests. Now you should see a green test.

0 commit comments

Comments
 (0)