Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 4.16 KB

README.md

File metadata and controls

96 lines (61 loc) · 4.16 KB
saleor-app-template

Saleor App Template

Bare-bones boilerplate for writing Saleor Apps with Next.js.

Tip

Questions or issues? Check our discord channel for help.

What is Saleor App

Saleor App is the fastest way of extending Saleor with custom logic using asynchronous and synchronous webhooks (and vast Saleor's API). In most cases, creating an App consists of two tasks:

  • Writing webhook's code executing your custom logic.
  • Developing configuration UI to be displayed in Saleor Dashboard via specialized view (designated in the App's manifest).

What's included?

  • 🚀 Communication between Saleor instance and Saleor App
  • 📖 Manifest with webhooks using custom query

Why Next.js

You can use any preferred technology to create Saleor Apps, but Next.js is among the most efficient for two reasons. The first is the simplicity of maintaining your API endpoints/webhooks and your apps' configuration React front-end in a single, well-organized project. The second reason is the ease and quality of local development and deployment.

Learn more about Apps

Apps guide

Development

Requirements

Before you start, make sure you have installed:

  1. Install the dependencies by running:
pnpm install
  1. Start the local server with:
pnpm dev

  1. Expose local environment using tunnel: Use tunneling tools like localtunnel or ngrok.

  2. Install the application in your dashboard:

If you use Saleor Cloud or your local server is exposed, you can install your app by following this link:

[YOUR_SALEOR_DASHBOARD_URL]/apps/install?manifestUrl=[YOUR_APP_TUNNEL_MANIFEST_URL]

This template host manifest at /api/manifest

You can also install application using GQL or command line. Follow the guide how to install your app to learn more.

Generated schema and typings

Command generate would generate schema and typed functions using Saleor's GraphQL endpoint. Commit the generated folder to your repo as they are necessary for queries and keeping track of the schema changes.

Learn more about GraphQL code generation.

Storing registration data - APL

During the registration process, Saleor API passes the auth token to the app. With this token App can query Saleor API with privileged access (depending on requested permissions during the installation). To store this data, app-template use a different APL interfaces.

The choice of the APL is made using the APL environment variable. If the value is not set, FileAPL is used. Available choices:

  • file: no additional setup is required. Good choice for local development. It can't be used for multi tenant-apps or be deployed (not intended for production)
  • upstash: use Upstash Redis as storage method. Free account required. It can be used for development and production and supports multi-tenancy. Requires UPSTASH_URL and UPSTASH_TOKEN environment variables to be set

If you want to use your own database, you can implement your own APL. Check the documentation to read more.