djkato/saleor-apps-redis_apl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
saleor-apps-redis_apl/apps/cms
History
Lukasz Ostrowski 7cb3b892c4
Author field in manifests (#299) 
* Update app-sdk to 0.37.0

* Add author field to manifest handler

* Fix build by fixing AppPermission in tRPC (use Permission instead) and replace domain with saleorApiUrl (compat with 0.37.1 sdk)

* Update app-sdk to 0.37.1
2023-03-16 19:09:26 +01:00
..
docs Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
graphql Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
src Author field in manifests (#299) 2023-03-16 19:09:26 +01:00
.env.example Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
.eslintrc Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
.graphqlrc.yml Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
CONTRIBUTING.md Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
next-env.d.ts Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
next.config.js Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
package.json Author field in manifests (#299) 2023-03-16 19:09:26 +01:00
README.md Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
saleor-app.ts Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
tsconfig.json Add CMS hub app (#262) 2023-03-16 11:17:00 +01:00
vitest.config.ts CMS setup tests fix (#294) 2023-03-16 12:13:16 +01:00

README.md

CMS

CMS

Overview

What is it?

CMS Hub is a Saleor app that exports products from Saleor to several popular CMSes.

Here is a list of currently supported CMSes and their configuration guides:

How does it work?

  1. cms listens to Saleor product variant events through webhooks.
  2. When an event is triggered, we extract the product data and pass it to the CMS Client.
  3. CMS Client checks what CMS you picked, transforms the data to the format the CMS expects, and sends it over.

Assumptions

Currently, the CMS Hub does not support mapping Saleor fields to your CMS fields. We assume that products in your CMS have the following fields:

  • strings fields: saleor_id, name, product_id, product_name, product_slug,
  • JSON fileds: channels.

How to use it?

  1. Install the application in your Dashboard and open it.
  2. Go to Providers.
  3. Add CMS provider instance with proper configuration.
  4. Go to Channels.
  5. Turn on provider instances for desired channels.
  6. Go to Products in Dashboard.
  7. Add, edit or remove product variant to see it is added, updated or removed in configured CMS provider accordingly.

How can I contribute?

See CONTRIBUTING.md.