We are really excited that you are interested in contributing. This is a general contribution guide for most of Odestry's projects. Before submitting your contribution, please make sure to take a moment and read through the following guide:
To run the development server, you'll need to have Shopify CLI as well as Node.js installed on your machine.
- Install the dependencies
npm install- Connect to your store
To connect your store update the shopify.theme.toml file with your store's information.
[environments.development]
store = "john-apparel.myshopify.com"- Start the development server
npm run devAfter authenticating, this will start a local development server running at https://localhost:9292 that you can use to preview your changes.
There are a number of really useful tools that the Shopify Themes team uses during development. This theme is already set up to work with these tools.
Shopify CLI helps you build Shopify themes faster and is used to automate and enhance your local development workflow. It comes bundled with a suite of commands for developing Shopify themes—everything from working with themes on a Shopify store (e.g. creating, publishing, deleting themes) or launching a development server for local theme development.
You can follow this quick start guide for theme developers to get started.
Tailwind CSS is a utility-first CSS framework for rapidly building custom storefront interfaces. It's a great way to build Shopify themes and sections quickly. You can find the configuration file at tailwind.config.ts. We use Vite to compile Tailwind CSS.
We recommend using Theme Check as a way to validate and lint your Shopify themes.
Theme Check is a command line tool that runs a series of tests against your theme code to surface errors, deprecations, and potential bugs. It's a great way to ensure your theme is up to date with the latest best practices and that you're not using any deprecated Liquid or JSON fields.
You can also run it from a terminal with the following Shopify CLI command:
shopify theme checkThis theme uses GitHub Actions to maintain the quality of the theme. This is a starting point and what we suggest to use in order to ensure you're building better themes. Feel free to build off of it!
We love fast websites! Which is why we created Shopify/lighthouse-ci-action. This runs a series of Google Lighthouse audits for the home, product and collections pages on a store to ensure code that gets added doesn't degrade storefront performance over time.
This theme runs Theme Check on every commit via Shopify/theme-check-action.