9f0dd813a4
* feat: ✨ add taxes app * chore: 🔥 remove files, use monorepo ones instead * chore: ✨ add all env vars to .env.example * refactor: 🔧 use saleor eslint config * build: ⬆️ app-sdk, remove vercel from apl * refactor: ♻️ remove providers/index, infer taxProviders from providerConfig * refactor: ♻️ use tuples to use objects * refactor: 🚚 move types to taxes module * refactor: ♻️ tax-prepare-data -> tax-line-resolver * refactor: get isInFrame from apps-shared * build: ⬆️ next * feat: ✨ add appRegister allowlist * Update apps/taxes/src/pages/api/manifest.ts Co-authored-by: Krzysztof Wolski <krzysztof.k.wolski@gmail.com> * Update apps/taxes/src/pages/api/manifest.ts Co-authored-by: Krzysztof Wolski <krzysztof.k.wolski@gmail.com> * chore: 💡 improve comments * refactor: 🔥 app-dashboard-link * docs: 📝 add taxes to readme * refactor: 🔥 app-main-bar * refactor: ♻️ align saleor-app.ts with the rest * refactor: ♻️ use defaultValues * chore: ♻️ misc --------- Co-authored-by: Krzysztof Wolski <krzysztof.k.wolski@gmail.com>
92 lines
2.4 KiB
Markdown
92 lines
2.4 KiB
Markdown
|
|
|
|
<div align="center">
|
|
<h1>Saleor Apps</h1>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<p>The central space for Saleor Apps, Integrations and Marketplace.
|
|
</div>
|
|
|
|
<div align="center">
|
|
<a href="https://saleor.io/">🏠 Website</a>
|
|
<span> • </span>
|
|
<a href="https://docs.saleor.io/docs/3.x">📚 Docs</a>
|
|
<span> • </span>
|
|
<a href="https://saleor.io/blog/">📰 Blog</a>
|
|
<span> • </span>
|
|
<a href="https://twitter.com/getsaleor">🐦 Twitter</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<a href="https://docs.saleor.io/docs/3.x/developer/extending/apps/quickstart/getting-started">🆕 Apps Quickstart</a>
|
|
<span> • </span>
|
|
<a href="https://github.com/orgs/saleor/projects/22/views/1">🗓️ Roadmap</a>
|
|
<span> • </span>
|
|
<a href="https://github.com/saleor/apps/discussions/categories/integrations-features">✍️ Propose an app</a>
|
|
</div>
|
|
|
|
## 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/docs/3.x/developer/extending/apps/key-concepts)
|
|
|
|
### Apps list
|
|
|
|
In the `apps` folder, you will find the following applications:
|
|
|
|
- [data-importer](./apps/data-importer) - import data from CSV to Saleor.
|
|
- [invoices](./apps/invoices) - generate invoice PDF for each order.
|
|
- [klaviyo](./apps/klaviyo) - send Saleor events to Klaviyo, where you can notify the customers.
|
|
- [search](./apps/search) - connect Saleor with search engines.
|
|
- [slack](./apps/slack) - get notifications on Slack channel from Saleor events.
|
|
- [taxes](./apps/taxes) - calculate order and checkout taxes using external services.
|
|
|
|
## Development
|
|
|
|
### Setup
|
|
|
|
Make sure you have installed `pnpm`:
|
|
|
|
```bash
|
|
npm install -g pnpm
|
|
```
|
|
|
|
Install all dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Start the apps` dev servers:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
> The apps' ports will be displayed in the terminal output.
|
|
>
|
|
> You can find the required env vars for each app in `apps/NAME/.env.example` file.
|
|
|
|
To start an individual app, run:
|
|
|
|
```bash
|
|
pnpm dev --filter=saleor-app-X
|
|
```
|
|
|
|
where X is the app's name (matching saleor/X).
|
|
|
|
### Build
|
|
|
|
To build all apps, run:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
### Documentation
|
|
|
|
- [Forking](/docs/forking.md)
|