Octantis

View Source

Octantis is an implementation of Polaris Design System in Elixir for Phoenix LiveView. If you are building a ShopAdmin for your Shopify App (Shopify calls this embedded app home at times), and want to conform to the Shopify perscribed design system, then you will want to use Octantis.

Octantis provides Polaris LiveView components that you can drop into your LiveView Shop admin.

Example 

<.card >
  <.text as="h2" variant="bodyMd">
    Welcome to The Littlest Marble Shop
  </.text>
</.card>

σ Octantis

σ Octantis is the current southern pole star in opposition to Polaris the current northen pole star.

Other Resource

  • Elixir ShopifyAPI is most of what you need to interact with Shopify APIs. Auth, Rest, Graphql, Webhooks and so on.
  • Elixir Shopify App is a template for building an App with Elixir ShopifyAPI. Currently it lacks a LiveView ShopAdmin as a default, but there is some work towards enabling that.
  • Polaris Design System
  • Shopify AppBridge provides some functionality for the ShopAdmin, noteably toasts and navigation menues.

Installation

If available in Hex, the package can be installed by adding octantis to your list of dependencies in mix.exs:

def deps do
  [
    {:octantis, "~> 0.1.0"}
  ]
end

Setup A LiveView Shop Admin

TODO

AppBridge Integration

TODO

Add Storybook and Routes

TODO

Local Setup

Run tests 

mix check

Run Storybook 

mix phx.server

Navigate to http://localhost:4040/storybook