This repository aims ait helping you connect your Akeneo PIM to a Proximis e-commerce solution. In this matter, the data contained in akeneo (products, categories, families, attributes, images, etc.) is transferred to Proximis's data manager through FTP and CSV files.
This project uses Kiboko Middleware's compiler in order to build data pipelines. Those pipelines are built to transform Akeneo's API data into Proximis' CSV file format, therefore you will be able to import those files either through the Data Manager, or send them through FTP.
Each pipeline is declared in a separate folder, we use a makefile to orchestrate the compilation and execution of all of
them in the right order. Each data flow is independent of the others, it is defined by a satellite.yaml file you can
customize following your business needs and constraints. Those files are used by the compiler to build a separate and
independent PHP CLI script aimed at being run from a crontab, a scheduler or your shell.
- PHP >= 8.0
- Composer 2
- An ElasticStack (ElasticSearch + Kibana) installation (check Docker installation instructions if you need a quick start)
If you are a developer, you may also need those tools:
- xdebug PHP extension
- Postman with Akeneo's collection and environments
git clone [email protected]:php-etl/proximis-skeletton.git your-projectcd your-projectcomposer install
If you are using docker, you may also need to run docker compose up -d. If you have an error related to networking or
ports availability, you may need to create an .env file to change the default ports.
Environment variables are the following:
ELASTICSEARCH_PORTfor ElesticSearch's public API port (default: 9200)KIBANA_PORTfor Kibana's public UI port (default: 5601)
At the root of the project, there is a makefile you can use to reduce the amount of actions required to make the middleware work.
Run make to run the middleware. If you did not compile it beforehand, it will be automatically built before being executed.
Run make build