{"id":13546520,"url":"https://github.com/ASoftCo/shopify-app-starter-kit","last_synced_at":"2025-04-02T18:30:55.793Z","repository":{"id":75408302,"uuid":"102475220","full_name":"ASoftCo/shopify-app-starter-kit","owner":"ASoftCo","description":"Shopify app starter kit written in Ruby on Rails w/ appropriate tools to get your Shopify app up and running quickly 🚀","archived":false,"fork":false,"pushed_at":"2019-04-23T14:05:49.000Z","size":106,"stargazers_count":42,"open_issues_count":0,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-25T02:51:35.596Z","etag":null,"topics":["boilerplate","ruby","ruby-on-rails","shopify","shopify-api","shopify-apps","starter-kit"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ASoftCo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-09-05T11:53:13.000Z","updated_at":"2025-03-17T16:08:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"18072113-4bb5-49e4-93ad-465cef3f37b8","html_url":"https://github.com/ASoftCo/shopify-app-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ASoftCo%2Fshopify-app-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ASoftCo%2Fshopify-app-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ASoftCo%2Fshopify-app-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ASoftCo%2Fshopify-app-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ASoftCo","download_url":"https://codeload.github.com/ASoftCo/shopify-app-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246869690,"owners_count":20847176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","ruby","ruby-on-rails","shopify","shopify-api","shopify-apps","starter-kit"],"created_at":"2024-08-01T12:00:39.399Z","updated_at":"2025-04-02T18:30:55.440Z","avatar_url":"https://github.com/ASoftCo.png","language":"Ruby","readme":"# Shopify App Starter Kit\n\nThe Rails app with appropriate tools for quick starting developing shopify app.\n\n**How to install?**\n\n1. `git clone https://github.com/ASoftCo/shopify-app-starter-kit.git`\n2. `cd shopify-app-starter-kit`\n3. `git remote set-url origin new_git_repo_url`\n4. `bundle install \u0026\u0026 bundle exec rails db:create db:migrate`\n5. Install and run [Redis](https://redis.io/download)\n6. Rename the app module in the `config/application.rb` file\n7. Install [ngrok](https://ngrok.com/)\n8. Create a new app in your [shopify partner account](https://partners.shopify.com/organizations)  \n  - use ngrok url as a `App URL` in the `App setup` section  \n  - add `whitelisted redirection URL(s)`:  \n    http://\u003cyour_ngrok_host\u003e/auth/shopify/callback  \n    https://\u003cyour_ngrok_host\u003e/auth/shopify/callback  \n9. `rails credentials:edit` and add all settings from `config/credentials_sample.yml`\n10. Change all credential values in your `config/credentials.yml.enc` file to appropriate ones.\n  - change `api_key` and `secret` (can be found at the `App setup` section)\n  - change `host` setting to your ngrok url\n  - add [necessary shopify scopes](https://help.shopify.com/api/getting-started/authentication/oauth#scopes)\n  - add [necessary shopify webhooks](https://help.shopify.com/api/reference/webhook)\n11. Add necessary workers to the `app/jobs/` directory (e.g. if you add `orders/create` webhook, you should create `orders_create_job.rb` worker)\n12. For UI and CSS styles read about [Polaris](https://polaris.shopify.com/) or [Uptown CSS](http://www.uptowncss.com/)\n\n**Monitoring**\n\nThere are several monitoring tools: [New Relic](https://newrelic.com), [Sentry](https://sentry.io) and [Mixpanel](https://mixpanel.com).\nAll 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.\n","funding_links":[],"categories":["Examples","Happy Exploring 🤘","示例","Example Apps"],"sub_categories":["Ruby Examples","Ruby 示例"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FASoftCo%2Fshopify-app-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FASoftCo%2Fshopify-app-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FASoftCo%2Fshopify-app-starter-kit/lists"}