Giter VIP home page Giter VIP logo

getmarkus / astro-shopify-polaris Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 69 KB

Astro template for Shopify's Polaris Design System

Home Page: http://www.cmsoftdev.com/astro-shopify-polaris/

License: MIT License

JavaScript 1.88% TypeScript 87.18% Astro 10.94%
astro astro-build astro-build-template astro-template astro-theme astro-themes astrojs astrojs-template builtatlightspeed jamstack

astro-shopify-polaris's Introduction

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

astro-shopify-polaris's People

Contributors

getmarkus avatar

Stargazers

 avatar

Watchers

 avatar  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.