jtl-scx/channel

0.20.0 2024-04-25 09:34 UTC

Requires

• php: 8.3.*
• jtl-scx/channel-core: ^0.101.0
• monolog/monolog: ^2.9.3
• symfony/console: ^6.4.6
• symfony/dotenv: ^6.4.4
• twig/twig: ^3.9.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.54
• phpunit/phpunit: ^10.5.20
• psalm/phar: ^5.23

MIT

README

SCX-Channel

Skeleton Project to bootstrap a new SCX Channel Integration

How to start?

• Install project by using composer

composer create-project jtl-scx/channel channel 0.20.0

• You may set up your own namespace in composer.json (default: JTL\SCX\Channel)
• Create .env.local
  • default pointing to SCX Sandbox API
  • add your API Token

SCX_CHANNEL_API_USER_AGENT=3P_<YOUR-CHANNEL-NAME-HERE>
CHANNEL_NAME=<YOUR-CHANNEL-NAME-HERE>
SCX_CHANNEL_API_HOST=https://scx-sbx.api.jtl-software.com
SCX_CHANNEL_API_REFRESH_TOKEN=***

• Start development Environment
  • Run docker-compose up -d (this will create a nginx, php-fpm and a rabbitMQ container for you)
  • Run the application by execute ./run

Documentation

• API Documentation
• CLI Commands
• Meta Data
• Events and Messages
• Monitoring

Roadmap

• Setup a custom installer for composer