dmbf29/example-ruby-app

Example application written in Ruby for API documentation.

Shopify App Examples

This repository is home to the code examples highlighted in various Shopify API tutorials. They are designed solely for the purpose of introducing new developers to the Shopify API. The example apps are written in Sinatra, but the concepts presented will also apply to developers building applications in other languages such as Python, Node.js and PHP.

Tutorial index

01 Getting Started

• Building a public Shopify application (tutorial)

02 - Adding billing to your app

• Adding billing to your app (tutorial)

Requirements

• Ruby (sample apps were written with Ruby 2.2.1)
• Bundler for Ruby, a dependency manager
• Shopify Partners account

Credentials

Follow this guide to obtain your public app credentials from your Shopify Partners account.

This example apps use a .env file to store app credentials. After cloning the repository, you will need to create a file named .env in the same folder of the tutorial. Copy the values of the API Key and API Secret from your partner dashboard, and add them to the .env file in the following format:

API_KEY=YOUR_API_KEY
API_SECRET=YOUR_SECRET_KEY

where YOUR_API_KEY and YOUR_SECRET_KEY are the values of your application's API key and secret key respectively.

App URL

This tutorial series uses ngrok to create a secure tunnel from the internet to your local machine. For each installment in the series, you will need to copy the APP_URL generated by ngrok to your app.rb file. Additionally, the APP_URL needs to be added to the App URLs section of your public app settings. These procedures are covered in the Building a public Shopify application tutorial.

Running the app

bundle install

ruby 01\ Getting\ Started/app.rb