Packages
shopifex
0.3.1
2.4.0
2.3.0
2.2.2
2.2.1
2.2.0
2.1.20
2.1.19
2.1.18
2.1.17
2.1.16
2.1.15
2.1.14
2.1.13
2.1.12
2.1.11
2.1.10
2.1.9
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.1
2.0.0
1.1.1
1.1.0
1.0.1
1.0.0
0.6.2
0.6.1
0.6.0
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Phoenix boilerplate for Shopify Embedded App SDK
Current section
Files
Jump to
Current section
Files
lib/shopifex.ex
defmodule Shopifex do
@moduledoc """
# Welcome to Shopifex!
## Configuration (All configuration options are required)
* `:app_name` - This gets used in the Shopifex provided app installation page
* `:repo` - The Ecto.Repo for your application
* `:shop_schema` - Your Ecto.Schema that must have :url, :scopes, and :access_token properties. This is used to install and load stores into the session
* `:redirect_uri` - The redirect URI used in the Shopify app installation process. Must be whitelisted in your Shopify app configuration
* `:reinstall_uri` - The redirect URI used in the Shopify app reinstallation process. Must be whitelisted in your Shopify app configuration
* `:api_key` - Your Shopify app's API key
* `:secret` - Your Shopify app's secret
* `scopes` - Shopify OAuth scopes which your application requires
* `:webhook_uri` - When webhooks are created by Shopifex, this is used as the webhook endpoint
* `:webhook_topics` - Topics to subscribe to after installation is complete
Example:
```
config :shopifex,
app_name: "MyApp",
repo: MyApp.Repo,
shop_schema: MyApp.Shop,
api_key: "shopifyapikey123",
secret: "shopifyapisecret456",
redirect_uri: "https://myapp.ngrok.io/auth/install",
reinstall_uri: "https://myapp.ngrok.io/auth/update",
scopes: "read_inventory,write_inventory,read_products,write_products,read_orders",
webhook_uri: "https://myapp.ngrok.io/webhook",
webhook_topics: ["app/uninstalled"]
```
"""
end