Skip to content
Shopify app starter kit written in Ruby on Rails w/ appropriate tools to get your Shopify app up and running quickly πŸš€
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
tmp
vendor
.gitignore
.gitlab-ci.yml
.rubocop.yml
.rubocop_todo.yml
.ruby-version
Gemfile
Gemfile.lock
Procfile
README.md
Rakefile
config.ru
package.json

README.md

Shopify App Starter Kit

The Rails app with appropriate tools for quick starting developing shopify app.

How to install?

  1. git clone https://github.com/ASoftCo/shopify-app-starter-kit.git
  2. cd shopify-app-starter-kit
  3. git remote set-url origin new_git_repo_url
  4. bundle install && bundle exec rails db:create db:migrate
  5. Install and run Redis
  6. Rename the app module in the config/application.rb file
  7. Install ngrok
  8. Create a new app in your shopify partner account
  • use ngrok url as a App URL in the App setup section
  • add whitelisted redirection URL(s):
    http://<your_ngrok_host>/auth/shopify/callback
    https://<your_ngrok_host>/auth/shopify/callback
  1. rails credentials:edit and add all settings from config/credentials_sample.yml
  2. Change all credential values in your config/credentials.yml.enc file to appropriate ones.
  1. Add necessary workers to the app/jobs/ directory (e.g. if you add orders/create webhook, you should create orders_create_job.rb worker)
  2. For UI and CSS styles read about Polaris or Uptown CSS

Monitoring

There are several monitoring tools: New Relic, Sentry and Mixpanel. All that you need to do is to change the values of appropriate keys (new_relic_license_key, sentry_dsn, mix_panel_token) for your environment in the config/credentials.yml.enc file.

You can’t perform that action at this time.