https://github.com/saleor/apps
A central space for Saleor Apps, integrations, and the App Store 🚀
https://github.com/saleor/apps
apps commerce ecommerce nextjs saleor saleor-app saleor-avatax saleor-cms saleor-klaviyo saleor-search saleor-smtp
Last synced: 6 months ago
JSON representation
A central space for Saleor Apps, integrations, and the App Store 🚀
- Host: GitHub
- URL: https://github.com/saleor/apps
- Owner: saleor
- License: other
- Created: 2022-12-12T13:01:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:48:25.000Z (about 1 year ago)
- Last Synced: 2024-10-29T09:49:13.506Z (about 1 year ago)
- Topics: apps, commerce, ecommerce, nextjs, saleor, saleor-app, saleor-avatax, saleor-cms, saleor-klaviyo, saleor-search, saleor-smtp
- Language: TypeScript
- Homepage: https://apps.saleor.io
- Size: 13.5 MB
- Stars: 112
- Watchers: 4
- Forks: 307
- Open Issues: 88
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Saleor Apps
The central space for Saleor Apps, Integrations and Marketplace.
[](https://saleor.io/discord)
## Overview
This repository serves as a starting point in the exploration of Saleor apps.
> _Saleor apps are separate applications that use GraphQL to talk to the Saleor server and receive webhooks with event notifications from Saleor._
>
> [docs.saleor.io](https://docs.saleor.io/developer/extending/apps/overview)
### Apps list
In the `apps` folder, you will find the following applications:
- [AvaTax](./apps/avatax) - calculates dynamic taxes via AvaTax API.
- [CMS](./apps/cms) - exports products from Saleor to CMS.
- [Klaviyo](./apps/klaviyo) - send Saleor events to Klaviyo, where you can notify the customers.
- [Products feed](./apps/products-feed) - generate products feed XML.
- [Search](./apps/search) - connect Saleor with search engines.
- [Segment](./apps/segment/) - connect Saleor with Twilio Segment.
- [SMTP](./apps/smtp) - email communication with customers.
- [Stripe](./apps/stripe/) - connect Saleor with Stripe
#### Example apps
- [Slack integration app example](https://github.com/saleor/examples/tree/main/example-app-slack)
- [Taxjar integration app example](https://github.com/saleor/examples/tree/main/example-app-taxjar)
- [Invoices app example](https://github.com/saleor/examples/tree/main/example-app-invoices)
- [CRM app example](https://github.com/saleor/examples/tree/main/example-app-crm)
- [Sendgrid integration app example](https://github.com/saleor/examples/tree/main/example-app-sendgrid)
## Development
You can find the documentation for saleor/apps on [docs.saleor.io](https://docs.saleor.io/developer/extending/apps/local-app-development).
### PNPM and corepack
Due to an issue with [outdated signatures in Corepack](https://github.com/nodejs/corepack/issues/612), Corepack should be updated to its latest version first:
```shell
npm install --global corepack@latest
```
After that run to install pnpm with proper version:
```shell
corepack enable pnpm
```
### Turborepo
This repository uses [Turborepo](https://turbo.build/) remote caching. If you are Saleor employee you can leverage it by running following commands in root of this repository:
```shell
pnpm dlx turbo login
pnpm dlx turbo link
```
## ADR
This repository uses [architecture decision records](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) to document architectural decisions. You can find them in the `docs/adr` directory.
To add new ADR follow [the guide](https://github.com/npryce/adr-tools).
## Contributing
We love your contributions and do our best to provide you with mentorship and support. However, please keep in mind that `saleor/apps` monorepo is used by Saleor to host apps in Saleor infrastructure. While the code remains open source, the decisions in this repository are made to enable Saleor to maintain features needed by it's business goals.
If you are looking for an issue to tackle, take a look at issues labeled [`Good first issue`](https://github.com/saleor/apps/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+) and [`Help wanted`](https://github.com/saleor/apps/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
If nothing grabs your attention, check [our roadmap](https://saleor.io/roadmap) or [start a Discord discussion](https://saleor.io/discord) about a feature you'd like to see. Make sure to read our [Contribution Guidelines](http://docs.saleor.io/developer/community/contributing) before opening a PR or issue.
## Deployment
Apps are written in Next.js and are hosted on Vercel by Saleor. Everyone should be able to host the app on Vercel if the app is configured properly. Apps share common code, but some of the functionalities are app-specific. For example, Avatax and Segment apps require DynamoDB to run. Check each app's "env" files to verify what must be provided to deploy.
### Docker
Repository contains [Devcontainers](https://containers.dev/) setup which include Dockerfiles. They are meant for development. At the moment Saleor doesn't provide official production Dockerfiles. Feel free to write your own, based on the development ones.
### APLs
Apps follow BYOA (bring your own APL) approach. Minimal set of APLs are implemented in the source code, to avoid maintaining not used dependencies and increasing bundle size. You may want to use other APL client, like Redis. In such case, please ensure your fork does the job. Usually apps contain single file that imports APL from `@saleor/app-sdk`. Your fork can ensure this file contains your own APL setup
### MCP
To help AI agents properly interact with Saleor, you can use the [Model Context Protocol](https://modelcontextprotocol.io/introduction), which can interact with Saleor by understanding the GraphQL schema.
Start by populating `.env` file under `mcp` folder with:
```
MCP_GRAPHQL_ENDPOINT= # Saleor API endpoint (ends with /graphql/)
MCP_GRAPHQL_TOKEN= # local app token (see https://docs.saleor.io/api-usage/authentication#app-authentication for more details)
```
Make sure that you don't use quotes in env variables (as they will be loaded by bash script).
Then follow your editor docs to get started with MCP:
- [VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
- [Cursor](https://docs.cursor.com/context/model-context-protocol#configuration-locations)
- [JetBrains IDE](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)