cce2fbc3d5
* Bump macaw version * Make channels section expandable based on override setting * Add margins to dangerous section, improve copy * Add padding between section header and its description * Limit width of provider selection boxes * Use proper variant of the button * More whitespace between description and box in the sections * Remove text * Revert "Make channels section expandable based on override setting" This reverts commit e107c5e990b4110156043ed494fb0054bd936654. * Add changelog * Improve grammar Co-authored-by: Adrian Pilarczyk <admin@peelar.dev> --------- Co-authored-by: Adrian Pilarczyk <admin@peelar.dev> |
||
|---|---|---|
| .. | ||
| docs | ||
| graphql | ||
| src | ||
| .env.example | ||
| .eslintrc | ||
| .graphqlrc.yml | ||
| CHANGELOG.md | ||
| next-env.d.ts | ||
| next.config.js | ||
| package.json | ||
| README.md | ||
| saleor-app.ts | ||
| sentry.client.config.js | ||
| sentry.edge.config.js | ||
| sentry.server.config.js | ||
| tsconfig.json | ||
| turbo.json | ||
| vitest.config.ts | ||
Saleor App Search
About
Saleor App providing integration with the Algolia (and more search engines in the future).
What's included?
- Synchronize changes of your products catalog with Algolia
- Search results preview
- Each channel is a separate index
How to install
- start local dev server or deploy the application
- install the application in your Saleor Instance using manifest URL
- configure the application
Learn more about Apps
Development
Requirements
Before you start, make sure you have installed:
- Node.js
- pnpm
- Saleor CLI - optional, but recommended
- Install the dependencies by running:
pnpm install
- Start the local server with:
pnpm dev
- Expose local environment using tunnel:
- Use Saleor CLI
saleor app tunnel - Use tunneling tools like localtunnel or ngrok.
- Install application at 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
Commands build and dev 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 registration process Saleor API pass 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 done using APL environment variable. If value is not set, FileAPL is used. Available choices:
file: no additional setup is required. Good choice for local development. 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. Can be used for development and production and supports multi-tenancy. RequiresUPSTASH_URLandUPSTASH_TOKENenvironment variables to be set
If you want to use your own database, you can implement your own APL. Check the documentation to read more.