Skip to content
/ channel Public template

Skeleton Project to create a new SCX Channel Integration based on PHP

License

Notifications You must be signed in to change notification settings

jtl-scx/channel

Repository files navigation

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

Roadmap

  • Setup a custom installer for composer