-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c8a78c3
commit b297caf
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# shopify-boilerplate | ||
|
||
`shopify-boilerplate` is a starter kit for Shopify theme development. | ||
|
||
## Features | ||
|
||
- Type checking with [TypeScript](https://www.typescriptlang.org/) | ||
- Bundle TypeScript files using [Babel](https://babeljs.io/) | ||
- Transpile CSS files using [PostCSS](https://postcss.org/) | ||
- Lint and format files with [ESLint](https://eslint.org/), [Stylelint](https://stylelint.io/) and [Prettier](https://prettier.io/) | ||
- Use [Lefthook](https://github.com/evilmartians/lefthook) to run linters on Git staged files | ||
- Run linters on pull request using [GitHub Actions](https://github.co.jp/features/actions) | ||
|
||
## Requirements | ||
|
||
- [Volta](https://volta.sh/) | ||
- [rbenv](https://github.com/rbenv/rbenv) | ||
|
||
## How to use | ||
|
||
Clone this repository and install the dependencies: | ||
|
||
```bash | ||
npm i | ||
``` | ||
|
||
Rename the `.env.example` file to `.env`, and replace `YOUR_STORE_NAME` with your actual store name: | ||
|
||
```bash | ||
SHOPIFY_FLAG_STORE=YOUR_STORE_NAME | ||
``` | ||
|
||
This repository does not include any Shopify themes. You will need to add the theme files yourself. If you are creating a new theme, it is recommended to use [Dawn](https://github.com/Shopify/dawn) as a starting point (See the "[Getting started](https://github.com/Shopify/dawn?tab=readme-ov-file#getting-started)" section). | ||
|
||
## Available Commands | ||
|
||
### Start Development | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
### Build Scripts and Styles | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
### Lint Files | ||
|
||
```bash | ||
npm run lint | ||
``` | ||
|
||
### Fix Files | ||
|
||
```bash | ||
npm run fix | ||
``` | ||
|
||
## Recommended IDE | ||
|
||
[Visual Studio Code](https://code.visualstudio.com/) |