Skip to content

Commit

Permalink
Merge pull request #17 from spryker-sdk/example-of-directories-structure
Browse files Browse the repository at this point in the history
Updated README file with examples of directories structures
  • Loading branch information
dereuromark authored Mar 14, 2019
2 parents 037723d + af47b8b commit e14819d
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,32 @@ If you only need to add a new Spryk configuration you will start by adding an In

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.

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.
You need to add your Spryk definition file into `config/spryk/spryks/` on project or core level:

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.
```
project OR package root directory
└─── config/
│ └─── spryk/
│ │ └─── spryks/
│ │ │ ...
│ │ │ spryk-name.yml
│ │ │ ...
│ └─── ...
```

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:

```
project OR package root directory
└─── config/
│ └─── spryk/
│ │ └─── templates/
│ │ │ ...
│ │ │ template-name.twig
│ │ │ ...
│ └─── ...
```

When this is done re-run your tests. Now you should see a green test.

0 comments on commit e14819d

Please sign in to comment.