Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 2.4 KB

README.md

File metadata and controls

64 lines (38 loc) · 2.4 KB

3am 👻

3am is a shopify starter theme. 3am comes with nothing but shopify folder structure and tailwind config.

Usage

To get started clone the repo by clicking the <> Code button or by running the following command:

git clone https://github.com/Dhanush-git/3am-shopify.git

Running the development server

To run the development server, you'll need to have Shopify CLI as well as Node.js installed on your machine.

  1. Install the dependencies
npm install
  1. Connect to your store

To connect your store update the shopify.theme.toml file with your store's information.

[environments.dev]
store = "3am.myshopify.com"
  1. Start the development server
npm run dev

After authenticating, this will start a local development server running at https://localhost:9292 that you can use to preview your changes.

Tools

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

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

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.

Theme Check

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 check