https://github.com/bitcoinmitchell/cryptwerk-plugin
PrestaShop module to convert available products into a XML feed that CryptWerk can parse
https://github.com/bitcoinmitchell/cryptwerk-plugin
bitcoin crypto cryptwerk feed prestashop prestashop-1-7 prestashop-addon prestashop-free-addon prestashop-free-module prestashop-module xml
Last synced: 8 months ago
JSON representation
PrestaShop module to convert available products into a XML feed that CryptWerk can parse
- Host: GitHub
- URL: https://github.com/bitcoinmitchell/cryptwerk-plugin
- Owner: BitcoinMitchell
- License: mit
- Created: 2021-11-03T08:28:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-03T17:09:14.000Z (over 1 year ago)
- Last Synced: 2025-02-03T18:23:59.159Z (over 1 year ago)
- Topics: bitcoin, crypto, cryptwerk, feed, prestashop, prestashop-1-7, prestashop-addon, prestashop-free-addon, prestashop-free-module, prestashop-module, xml
- Language: PHP
- Homepage:
- Size: 440 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# CryptWerk Plugin
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/pulse)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/actions)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/blob/master/LICENSE)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/graphs/contributors)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
[](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases)
This is a CryptWerk plugin for PrestaShop. It converts your available products into an XML feed that CryptWerk can parse.
## Features
+ The module exposes a `/module/cryptwerk/feed` endpoint that outputs all in-stock products as XML.
+ Each product includes: ID, title, link, price, description, categories, image, and brand (if available).
+ The feed is automatically updated as your catalog changes.
+ Adds a `CryptWerk Feed` tab under Catalog in PrestaShop admin
## Requirements
Please ensure that you meet the following requirements before installing this plugin.
+ You have a [CryptWerk account](https://cryptwerk.com/id/register/).
+ You are using PHP 8.1 or higher.
+ Your PrestaShop is version 9.0.0 or higher.
+ The intl, mbstring and simplexml PHP extensions are available.
## Usage
1. [Download the latest CryptWerk plugin](https://github.com/bitcoinmitchell/cryptwerk-plugin/releases).
2. Go to your PrestaShop store and upload the zip via `Modules > Module Manager > Upload a module`.
3. Click on `Catalog -> CryptWerk Feed`, which will redirect you to your feed URL.
4. Setup product sync within CryptWerk `Dashboard -> Synchronization & Import` using the `XML` type and your feed URL.
5. Await moderator approval on CryptWerk.
## Development
If you want to work on the plugin, it is recommended to install/use the following:
- [Symfony CLI](https://symfony.com/doc/current/setup/symfony_cli.html) is required for Makefile and makes life easier.
- [PrestaShop Flashlight](https://github.com/PrestaShop/prestashop-flashlight)
- This is a newer, maintained version of [PrestaShop Kickstarter](https://github.com/PrestaShopCorp/docker-compose-kickstarter).
### Local development environment
1. Copy `development/.env.dist` to `development/.env` and adjust as needed.
2. Run:
```sh
cd development
docker compose up -d
```
3. Access PrestaShop at [http://localhost:8000](http://localhost:8000), which will redirect you to the proper Ngrok URL.
### Building and linting
- `make build` – Installs dependencies and builds `cryptwerk.zip` in the `build/` folder.
- `make lint` – Runs PHP CS Fixer and PHPCS for code style checks.
- `make clean` – Cleans build artifacts and vendor folders.
### Code structure
- `modules/cryptwerk/cryptwerk.php` – Main module class and PrestaShop integration
- `modules/cryptwerk/controllers/front/feed.php` – XML feed controller
- `modules/cryptwerk/src/Factory.php` – XML feed builder logic
- `modules/cryptwerk/config/routes.yml` – Custom routes
- `development/` – Docker, environment, and helper scripts
### Autocomplete
- `development/autocomplete.php` provides PrestaShop class stubs for IDE autocompletion.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://github.com/BitcoinMitchell/docker-prestashop/tags).
## Contributing
Contributors looking to help out, before opening a pull request, please [create an issue](https://github.com/bitcoinmitchell/cryptwerk-plugin/issues/new/choose)
to get early feedback, discuss the best ways to tackle the problem and to ensure there is no work duplication.
## Security
Please report security issues privately via email. See [SECURITY.md](SECURITY.md) for details.
## PrestaShop Support
PrestaShop support can be found through its official channels.
* [Homepage](https://www.prestashop.com)
* [Documentation](https://doc.prestashop.com)
* [Support Forums](https://www.prestashop.com/forums)
## License
Software, logo and designs are provided under [MIT License](LICENSE).