Skip to content

getmarkus/astro-shopify-polaris

Repository files navigation

Astro + Shopify's Polaris Admin Framework

Here is a quick theme template to experiment with Shopify's design system for Admin Apps called Polaris. The goal is to see if it works with Astro.

npm create astro@latest -- --template getmarkus/astro-shopify-polaris

Live Demo. Please keep in mind this is a work in progress and not functionally complete.

Breaking down this implementation into three broad steps.

See if Shopify's opinionated React components play well with Astro:

So far so good, Shopify's design system and React components seem to work well together on first attempt. The only core requirement was to make sure the Components are always wrapped in their App provider.

See if this integrates in with Shopify's system (WIP)

As would be expected Shopify has requirements for building Apps and Admin extentions that developers need to follow.

Shopify recommends and provides remix and node templates to get started. So this next experiment will be to see if Astro also works.

Finish out and comply with the full suite of App Design Guildlines (WIP)

Are their any Astro gotchas? I doubt it but this last step will test it out. Need to makes sure this will cover Shopify's App Design Guidelines

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI