Monorepo for Saleor App SDK and some apps
Find a file
2024-03-11 14:17:35 +01:00
.github/workflows Create rust-clippy.yml 2024-03-11 14:17:35 +01:00
app-template before adding GH CI 2024-03-11 14:11:47 +01:00
sdk before adding GH CI 2024-03-11 14:11:47 +01:00
simple-payment-gateway before adding GH CI 2024-03-11 14:11:47 +01:00
sitemap-generator before adding GH CI 2024-03-11 14:11:47 +01:00
.env sitemap make products and categories work 2024-03-07 22:14:42 +01:00
.env.example sitemap make products and categories work 2024-03-07 22:14:42 +01:00
.gitignore sitemap make products and categories work 2024-03-07 22:14:42 +01:00
.tokeinore add regeneration to sitemap, other fixes 2024-03-09 19:59:15 +01:00
app logo template.xcf reorganised into a workspace 2024-02-27 17:50:48 +01:00
bacon.toml refactor 2024-02-21 22:37:06 +01:00
Cargo.lock before adding GH CI 2024-03-11 14:11:47 +01:00
Cargo.toml add regeneration to sitemap, other fixes 2024-03-09 19:59:15 +01:00
FUNDING.yml Prepare for publishing 2024-02-27 20:05:09 +01:00
PolyForm-Noncommercial-1.0.0.md sitemap app, lots of other stuff lol 2024-03-06 16:42:04 +01:00
README.md before adding GH CI 2024-03-11 14:11:47 +01:00

Buy Me a Coffee at ko-fi.com

This repo contains the following main components:

Crate Description
saleor-app-sdk Types and utilities for making Saleor Apps
saleor-app-template Simple template for making Saleor apps using axum
saleor-app-sitemap Saleor App for keeping sitemap.xml uptodate

Using this repo

To use, you need to have Rust environment prepared. Every folder represents a different workspace. To add a new lib, do cargo new <project-name> --lib or cargo new <project-name> for binary apps. It should appear as a new member under root Cargo.toml

Unofficial Saleor App SDK

SDK for building Saleor Apps to use in your project outside this repo: cargo add saleor-app-sdk to use in your project inside this repo, create a new workspace member and add saleor-app-sdk.workspace = true to the members Cargo.toml

Unofficial Saleor App Template

Creating a new Saleor App from template

If using the saleor-app-template, create a new workspace member cargo new <project-name>,rm -rf <project-name>/* then cp -r app-template/* <project-name>/.

Adding new dependencies

Workspace dependencies need to be managed manually. If you wanna add a new dependency to a single member do cargo add <dep> --package <project-name>. If you want to use a shared dependency, add it to the root level Cargo.toml, then inside your member Cargo.tomladd it under depencency like: <dependency> = { workspace = true, features = [ "..." ] }.

Developing

To have the app rebuild during development, install bacon cargo install bacon, then run bacon run -- <app-name> to have bacon watch your code and rerun it on save!

License

Each workspace member has it's licensed in it's own directory.

TL;DR:

  • saleor-app-sdk, saleor-app-template and the root structure fall under either MIT or Apache 2.0 at your convenience.
  • Rest of the apps in this repo fall under PolyForm-Noncommercial-1.0.md. If you want to use my apps commercially, each app costs 10€ (or voluntarily more). Upon payment/donation you are allowed to use the given app commercially.