https://github.com/orbit-apps/elixir-shopify-app

Example Elixir Shopify App
https://github.com/orbit-apps/elixir-shopify-app

library

Last synced: 9 days ago
JSON representation

Example Elixir Shopify App

• Host: GitHub
• URL: https://github.com/orbit-apps/elixir-shopify-app
• Owner: orbit-apps
• License: apache-2.0
• Created: 2019-04-10T18:21:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T19:59:34.000Z (3 months ago)
• Last Synced: 2024-08-02T12:22:31.418Z (3 months ago)
• Topics: library
• Language: Elixir
• Size: 912 KB
• Stars: 16
• Watchers: 9
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-shopify - orbit-apps/elixir-shopify-app - Elixir Shopify App boilerplate (Phoenix). (Examples / Elixir Examples)

README

        
## Elixir Shopify App

Everything you need to get [Elixir Shopify API](https://github.com/pixelunion/elixir-shopifyapi) up and running.

## Usage

1. Clone this project `git clone https://github.com/pixelunion/elixir-shopify-app.git`

1. Rename the directory to a new project name `mv elixir-shopify-app your_project_name`

1. Delete the internal Git directory `rm -rf .git`

1. Run the boilerplate setup script `./boilerplate-setup.sh YourProjectName`

1. Create a new Git repository `git init`

1. Create the initial Git commit `git add -A`

1. Create the initial Git commit `git commit -m "Initial commit"`

1. Setup a Shopify App

  - Add the API key and secret to your `.envrc.private`

  - Update the allowed URLs to include `https://public-facing-url.ngrok.com/shop/authorized/your_project_name`

1. Start your database `docker-compose up -d`

1. Fetch dependencies

  - `mix deps.get`

  - `mix ecto.setup`

  - `cd assets && yarn install && cd ..`

1. Start your app `mix phx.server` or `iex -S mix phx.server`

1. Initiate install via `localhost:4000/shop/install?app=new_app_name&shop=mydevshop.myshopify.com`

## Credits

Boilerplate idea and install script borrowed from [Mirego](https://github.com/mirego/elixir-boilerplate)