https://github.com/adobe/commerce-events
Storefront data collection for Adobe Commerce
https://github.com/adobe/commerce-events
Last synced: about 2 months ago
JSON representation
Storefront data collection for Adobe Commerce
- Host: GitHub
- URL: https://github.com/adobe/commerce-events
- Owner: adobe
- License: mit
- Created: 2022-06-20T19:50:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-30T14:09:29.000Z (about 2 months ago)
- Last Synced: 2026-04-30T16:09:36.182Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://developer.adobe.com/commerce/services/shared-services/storefront-events
- Size: 3.78 MB
- Stars: 11
- Watchers: 13
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Adobe Commerce Events
A monorepo for Adobe Commerce Events packages. This repo is using [turborepo](https://turborepo.org/) to manage packages.
## Getting Started
This turborepo uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package manager. Install yarn if you haven't already by running `npm install -g yarn`.
### Develop
To develop all apps and packages, run the following command:
```
cd commerce-events
yarn dev
```
This runs all packages and examples at the same time. The newer examples are using [NextJS](https://nextjs.org/) to make sure we cover use cases for modern package development. Under the old-examples, we are using [parcel](https://parceljs.org/) to just quickly host static files and test our amd/umd scripts.
Under the dev script, our built files are hosted at:
- sdk - `http://localhost:8080/index.js`
- collector - `http://localhost:8081/index.js`
## Release process
### QA
Merging a change to the `main` branch triggers a github action that builds and deploys the latest code to QA: https://cdn.jsdelivr.net/npm/@adobe/magento-storefront-event-collector@qa/dist/index.js.
### Production
Release steps:
- create a PR with a version bump in the package.json and package-lock.json in the package(s) you're releasing (example PR [here](https://github.com/adobe/commerce-events/pull/56/files))
- once the PR is approved and merged, create a [new release tag for the repo](https://github.com/adobe/commerce-events/tags)
Creating a new release tag triggers a github action that builds and deploys the latest code to Prod: https://cdn.jsdelivr.net/npm/@adobe/magento-storefront-event-collector/dist/index.js.
### NPM Packages
| Name | NPM Namespace | version |
| --------------------------------------------------------------------- | ------------------------------------------- | ------- |
| [storefront-events-sdk](./packages/storefront-events-sdk) | `@adobe/magento-storefront-events-sdk` | 1.x |
| [storefront-events-collector](./packages/storefront-events-collector) | `@adobe/magento-storefront-event-collector` | 1.x |