Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaudaj/prestashop-maker
Boilerplate code generator for PrestaShop
https://github.com/kaudaj/prestashop-maker
maker-bundle prestashop symfony
Last synced: 4 months ago
JSON representation
Boilerplate code generator for PrestaShop
- Host: GitHub
- URL: https://github.com/kaudaj/prestashop-maker
- Owner: Kaudaj
- License: afl-3.0
- Created: 2021-11-03T09:51:14.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-06-24T21:42:39.000Z (over 2 years ago)
- Last Synced: 2024-10-10T00:41:53.705Z (4 months ago)
- Topics: maker-bundle, prestashop, symfony
- Language: PHP
- Homepage:
- Size: 261 KB
- Stars: 17
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PrestaShop Maker
[](https://GitHub.com/Kaudaj/prestashop-maker/releases/)
[](https://github.com/Kaudaj/prestashop-maker/LICENSE.md)
[](https://php.net/)
[](https://github.com/Kaudaj/prestashop-maker/actions/workflows/php.yml)
PrestaShop Maker is a tool to generate boilerplate code for [PrestaShop][prestashop] projects.
It uses [Symfony MakerBundle](https://symfony.com/bundles/SymfonyMakerBundle/current/index.html) to generate code and then move the changes to your own project.
## Guide
### Installation
- Stable version
[Download a release](https://github.com/Kaudaj/prestashop-maker/releases/).
- Latest version
Clone the repository.
```bash
git clone https://github.com/Kaudaj/prestashop-maker.git
cd prestashop-maker
composer install
```
### Usage
PrestaShop Maker adds a new command: `make-to`.
```bash
make-to
```
*Example*:
```bash
php /path/to/prestashop-maker/bin/console make-to /path/to/prestashop/project make:ps:grid
```
#### Working on a module
If you want to generate the files to a module instead of PrestaShop core, use `-m` option with the module class name.
You can also define `DESTINATION_MODULE` environment variable instead (in `/.env.local`). It's practical if you're actively working on the same module, so you don't have to retype it everytime in the `make-to` command.
*Example*:
```bash
php /path/to/prestashop-maker/bin/console make-to /path/to/prestashop/project make:ps:grid -m MyModule
```
#### Recommended: Create an alias
As you can see, it will be quickly tiring to type the whole prestashop-maker console path each time.
It is highly recommended to define a simpler shortcut that you can use anywhere.
Instructions are available in this [gist](https://gist.github.com/Kaudaj/cf416de07a615c000a69da5ea44b1e86).
Replace `` with `php /path/to/prestashop-maker/bin/console make-to` and `your-alias` with whatever you want.
As you can see, calling the make-to command then becomes much easier:
```bash
your-alias /path/to/prestashop/project make:ps:grid
```
## Makers
### Current makers
To get the list of all the available makers, you can run the following command:
```bash
php bin/console list make
```
To get the list of the makers from PrestaShop Maker only, run this one:
```bash
php bin/console list make:prestashop
# or
php bin/console list make:ps
```
### Planned makers
- `make:prestashop:controller` PrestaShop [Controller](https://devdocs.prestashop.com/1.7/modules/concepts/controllers/)
- `make:prestashop:kpi` PrestaShop [KPI](https://devdocs.prestashop.com/1.7/modules/concepts/controllers/kpi-blocks/)
- ~~`make:prestashop:grid` PrestaShop [Grid](https://devdocs.prestashop.com/1.7/development/components/grid/)~~
- ~~`make:prestashop:crud-form` PrestaShop [CRUD Form](https://devdocs.prestashop.com/1.7/development/architecture/migration-guide/forms/crud-forms/)~~
- ~~`make:prestashop:crud-cqrs` PrestaShop CRUD [CQRS](https://devdocs.prestashop.com/1.7/development/architecture/domain/cqrs/)~~
- ~~`make:prestashop:cqrs` PrestaShop [CQRS](https://devdocs.prestashop.com/1.7/development/architecture/domain/cqrs/)~~
- ~~`make:prestashop:settings-form` PrestaShop [Settings Form](https://devdocs.prestashop.com/1.7/development/architecture/migration-guide/forms/settings-forms/)~~
- ~~`make:prestashop:multi-lang-entity` PrestaShop [Multi-Lang Entity](https://devdocs.prestashop.com/1.7/modules/concepts/doctrine/how-to-handle-multi-lang-doctrine-entity/)~~
## To go further
### Reporting issues
You can report issues with this module in this very repository. [Click here to report an issue](https://github.com/Kaudaj/prestashop-maker/issues/new/choose).
### Contributing
As it is an open source project, everyone is welcome and even encouraged to contribute with their own improvements!
To contribute in the best way possible, you want to follow the [PrestaShop contribution guidelines](https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/).
### License
This module is released under the [Academic Free License 3.0](https://opensource.org/licenses/AFL-3.0).
### Contact
Feel free to contact me by email at [[email protected]](mailto:[email protected]).
[prestashop]: https://www.prestashop.com/