Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getmarkus/astro-shopify-polaris
Astro template for Shopify's Polaris Design System
https://github.com/getmarkus/astro-shopify-polaris
astro astro-build astro-build-template astro-template astro-theme astro-themes astrojs astrojs-template builtatlightspeed jamstack shopify shopify-app shopify-apps static-site-generator template theme themes
Last synced: 3 days ago
JSON representation
Astro template for Shopify's Polaris Design System
- Host: GitHub
- URL: https://github.com/getmarkus/astro-shopify-polaris
- Owner: getmarkus
- License: mit
- Created: 2023-12-17T18:55:40.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-17T19:53:26.000Z (11 months ago)
- Last Synced: 2024-10-17T13:50:47.152Z (19 days ago)
- Topics: astro, astro-build, astro-build-template, astro-template, astro-theme, astro-themes, astrojs, astrojs-template, builtatlightspeed, jamstack, shopify, shopify-app, shopify-apps, static-site-generator, template, theme, themes
- Language: TypeScript
- Homepage: http://www.cmsoftdev.com/astro-shopify-polaris/
- Size: 67.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Astro + Shopify's Polaris Admin Framework
Here is a quick theme template to experiment with Shopify's design system for Admin Apps called [Polaris](https://polaris.shopify.com/). The goal is to see if it works with [Astro](https://astro.build).
```bash
npm create astro@latest -- --template getmarkus/astro-shopify-polaris
```
[Live Demo](https://www.christophermarkus.com/astro-shopify-polaris/). 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](https://github.com/Shopify/polaris/tree/main/polaris-react) 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](https://polaris.shopify.com/components/utilities/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](https://shopify.dev/docs/apps/tools#app-templates).
Shopify recommends and provides [remix](https://github.com/Shopify/shopify-app-template-remix) and [node](https://github.com/Shopify/shopify-app-template-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](https://shopify.dev/docs/apps/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 |