Git Product home page Git Product logo

slim-shopify-node-app's Introduction

Slim Shopify Node.js App

A trimmed down boilerplate for an embedded Shopify Application

What?

Included features:

  • A Koa.js server that uses Shopify's library for OAuth
  • koa-router
  • ejs to render a minimal HTML view
  • An App Bridge connection

This project is more about what isn't included:

  • React/Next.js or any client library
  • Preprocessing like Babel
  • project configuration like linting
  • testing (be sure to add some!)

Why ejs though? To pass the API key to App Bridge on the front end. Adding a client build process could replace ejs.

Get Started

Requirements

  • Node.js
  • Shopify Partner account
  • Shopify CLI (be sure to login first)
  • a (probably fresh) Shopify app
  • a development shop

Setup

Clone this repo to your local environment and a few Shopify CLI commands:

git clone [email protected]:tbeseda/slim-shopify-node-app.git my-new-app
cd my-new-app
npm i # or yarn

Make sure your Shopify CLI is logged in then connect this codebase to your app and store:

shopify whoami
shopify node connect

Start the server:

shopify node serve

Use the URL provided by the CLI to install your app.

Once authenticated you should be redirected to the main index showing a simple <h1> and a "Toast" confirming that App Bridge connected ๐Ÿ‘

Next Steps

Build your app!

  1. pick a database (gotta save those access tokens)
  2. use a client build process
  3. add some of the tools offered by Shopify (like Polaris)
  4. deploy to the cloud
  5. get your app approved

slim-shopify-node-app's People

Contributors

tbeseda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.