Adapting app to run on CLI 3

[paulomarg]

This takes the previous CLI 2 instance of a rails app and adapts it to CLI 3.

To 🎩:

1. yarn create @shopify/app --template https://github.com/Shopify/shopify-app-template-ruby#run_on_cli_3
2. dev clone shopify_app (or dev cd)
3. git checkout allow_custom_oauth_routes
4. pwd
5. Go back to the app folder, edit web/Gemfile, add , path: '<result from above>' to the line for shopify_app
6. cd web
7. bundle
8. bin/rails db:migrate
9. cd ..
10. yarn dev

Steps 2-5 will not be necessary once we publish a new version of shopify_app with Shopify/shopify_app#1445

[paulomarg]

Dumping a few things will be pending once this is merged (most are pretty small):

• Setting up github files / CI / CODEOWNERS, PR templates, CLA, etc.
• Making sure webhooks work as expected
• Making sure the app can be uninstalled and reinstalled without a db reset
• Adding the /api/products-count endpoint
• GDPR webhook handling
• Billing
• Setting this app up to run in production mode
• Setting up a README / hosting instructions
• Adding it as an option when creating a new app with the CLI

[teddyhwang]

Shouldn't we have shopify_app generate these files?

[paulomarg]

I think there's an argument for both cases here. All of the changes I made were to take the app generated by shopify_app and replace the default FE it outputs with the react app (and adjust routes accordingly).

Since the gem can be used to generate any app (including Shopify ones), I'm not sure we want the gem itself to produce something that uses the react app / CLI 3 structure by default - that would mean:

• Cloning the submodule internally and adding all of those files, which is awkward because:
  • If you re-generate things, it would go over each file asking if you want to replace it (unless we blindly copy it on top of what's there or fully ignore the folder which would lead to stuff breaking)
  • The generators kind of become a mini-version of CLI 2 since they have to handle cloning and stuff
• Whenever the generators are run, we'd try to re-create the FE app - unless we add different generators each time a version comes out that changes files.

If we assume re-generating would be out of the question, we'd still be left with a scenario where shopify_app would be in charge of updating the FE app, which I'm not sure is a problem or not - would people ever want to update their FE only?

[teddyhwang]

I think the generator would only be used to update this repo whenever changes are made to the rails structure. if we're fine to manually update these files on this repo every time there's a new rails version then I'm good with this approach.

would people ever want to update their FE only?

we need to make sure that we continue to position this as a starter template and not a framework that gets regular updates. the role of the template completes for the user after it has been scaffolded so with that in mind, is it better to keep this information inside of shopify_app?