Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 8.61 KB

README.md

File metadata and controls

109 lines (79 loc) · 8.61 KB

Adastra

PRs Welcome CI Discord Shield

A powerful, flexible suite of vite plugins for building unique and custom Shopify themes with next-gen frontend tools.

Install | Key Features | Packages | Templates | Documentation | Contributing | About | License

Install

The recommended way to scaffold an Adastra theme project is by running the command below:

npm create adastra@latest

Using Yarn/PNPM

yarn create adastra@latest
# pnpm create adastra@latest

Adastra came from the Latin word Ad-astra which stands for To the Stars

Key Features

  • Flexible Can seamlessly be integrated with existing workflows and Shopify themes.
  • Outstanding DX Lightning Fast HMR for static files and has custom CLI built on top of the Shopify CLI.
  • Fast, by default Supports modules/scripts code splitting and lazyloading static files.
  • UI-agnostic Supports React, Preact, Solid, Vue, Solid, Lit and more. (more examples coming soon)
  • Customizable Sensible built-in default configs for use in existing themes and highly extensible.

Requirements

Please make sure you have these two already set up in your local environment.

  • Node.js version 14 or higher (LTS recommended)
  • Shopify Theme CLI version 3.0.0 or higher

Packages

Package Changelog Version
adastra-plugin CHANGELOG npm package
adastra-cli CHANGELOG npm package
adastra-cli-kit CHANGELOG npm package
create-adastra CHANGELOG npm package
adastra-branding CHANGELOG npm package
adastra-prettier-config CHANGELOG npm package

Templates

Adastra comes with so many examples to showcase, how it can be used with all of these frontend tools and ui frameworks, to build next generation online storefronts.

Theme/Example Command
Basics Template (Tailwind & Prettier) npm create adastra@latest -- --template basics
Minimal Template npm create adastra@latest -- --template minimal
Necessary Template npm create adastra@latest -- --template necessary
Example with React npm create adastra@latest -- --template odestry/adastra/examples/with-react
Example with Vue npm create adastra@latest -- --template odestry/adastra/examples/with-vue
Example with Preact npm create adastra@latest -- --template odestry/adastra/examples/with-preact
Example with Solid npm create adastra@latest -- --template odestry/adastra/examples/with-solid
Example with Typescript npm create adastra@latest -- --template odestry/adastra/examples/with-typescript
Example with Lit npm create adastra@latest -- --template odestry/adastra/examples/with-lit
Example with Alpine npm create adastra@latest -- --template odestry/adastra/examples/with-alpine
Example with Tailwind npm create adastra@latest -- --template odestry/adastra/examples/with-tailwind
Example with GSAP npm create adastra@latest -- --template odestry/adastra/examples/with-gsap
Example with Sass npm create adastra@latest -- --template odestry/adastra/examples/with-sass
Example with Less npm create adastra@latest -- --template odestry/adastra/examples/with-less
Example with Vanilla Extract npm create adastra@latest -- --template odestry/adastra/examples/with-vanilla-extract
Example with React Three Fiber npm create adastra@latest -- --template odestry/adastra/examples/with-r3f
Example with React Hydrogen npm create adastra@latest -- --template odestry/adastra/examples/with-hydrogen

Documentation

You can check docs on every package.

  • Adastra Plugin Docs (here)
  • Adastra CLI Docs (here)
  • Adastra Create Theme CLI (here)

Contributing

We'd love your help! Please read our contributing guide to learn about our development process, how to propose bug fixes and improvements.

About

Odestry isn't just a community; it's a group of dedicated folks all aiming to build better commerce together. Our mission is to create a supportive and open space where anyone, regardless of experience, can connect, learn, and grow. Here, you'll get inspired, have real talks, and find plenty of resources and open source tools to help you build. Whether you're looking to network, find opportunities, or just have meaningful conversations, join us and be part of a community that values authenticity, collaboration, and innovation. Learn more.

License

Copyright (c) 2024-present Odestry. See LICENSE for further details.

Credit