Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/malipetek/shopify-serve-my-sw
Shopify app to serve service workers from assets
https://github.com/malipetek/shopify-serve-my-sw
Last synced: about 1 month ago
JSON representation
Shopify app to serve service workers from assets
- Host: GitHub
- URL: https://github.com/malipetek/shopify-serve-my-sw
- Owner: malipetek
- License: mit
- Created: 2022-12-13T22:32:30.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T04:58:53.000Z (about 2 years ago)
- Last Synced: 2024-11-11T03:22:09.122Z (3 months ago)
- Language: JavaScript
- Size: 2.54 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Shopify App Node
[](LICENSE.md)
This is a sample app to help developers bootstrap their Shopify app development.
It leverages the [Shopify API Library](https://github.com/Shopify/shopify-node-api) on the backend to create [an embedded app](https://shopify.dev/apps/tools/app-bridge/getting-started#embed-your-app-in-the-shopify-admin), and [Polaris](https://github.com/Shopify/polaris-react) and [App Bridge React](https://shopify.dev/tools/app-bridge/react-components) on the frontend.
This is the repository used when you create a new Node app with the [Shopify CLI](https://shopify.dev/apps/tools/cli).
## Requirements
- If you don’t have one, [create a Shopify partner account](https://partners.shopify.com/signup).
- If you don’t have one, [create a Development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) where you can install and test your app.
- **If you are not using the Shopify CLI**, in the Partner dashboard, [create a new app](https://help.shopify.com/en/api/tools/partner-dashboard/your-apps#create-a-new-app). You’ll need this app’s API credentials during the setup process.
## Installation
Using the [Shopify CLI](https://github.com/Shopify/shopify-cli) run:
```sh
shopify app create node -n APP_NAME
```
Or, you can run `npx degit shopify/shopify-app-node` and create a `.env` file containing the following values:
```yaml
SHOPIFY_API_KEY={api key} # Your API key
SHOPIFY_API_SECRET={api secret key} # Your API secret key
SCOPES={scopes} # Your app's required scopes, comma-separated
HOST={your app's host} # Your app's host, without the protocol prefix
```
## Developer resources
- [Introduction to Shopify apps](https://shopify.dev/apps/getting-started)
- [App authentication](https://shopify.dev/apps/auth)
- [Shopify CLI command reference](https://shopify.dev/apps/tools/cli/app)
- [Shopify API Library documentation](https://github.com/Shopify/shopify-node-api/tree/main/docs)
## License
This repository is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).