/Shopify-Theme-Starter-Vue3

Primary LanguageLiquid

Feature

.
├── src
└── shopify
    ├── assets
    ├── snippets
    ├── sections
        ├── homepage
            ├── banner.liquid
            └── slider.liquid
        ├── collection
            ├── card
                ├── cart.liquid
            	└── Card.ts
		        └── _card.scss
        
        ...
    ...
...
  • Build in Cart API
  • Build in Typing Shopify, Product, Cart, Collection...
  • Build in Filter Vue for Shopify ( Format Money, imgURL ... )
  • Build in Dom query
  • ...

How to code

  • Create private app, move config file to ./dist folder
  • Spit terminal
# Terminal 1
npm run dev ( development )
---
npm run build:prod ( production )
npm run build:dev:bundleanalyzer ( Analyzer dev )
npm run build:prod:bundleanalyzer ( Analyzer prod )
npm run docs ( Generator docs từ code )
npm run test ( Chạy Jest nếu có )

# Terminal 2
cd dist
theme watch

Một vài lưu ý khi làm việc với Branch

Quy tắc với các nhánh Code flow branches chính :

  • Development:
    • Branch name: dev
    • Tất cả tính năng hay là fix bugs thì đều lấy từ nhánh này. Các lỗi, tính năng, sửa đổi, refactor đều được merge or rebase vào nhánh này trước, sau khi test xong sẽ đẩy vào nhánh master - production.
  • Production, Master:
    • Branch name: master
    • Nhánh chính của project, luôn ở trạng thái ổn định, có thể tung các version từ nhánh này bất cứ lúc nào.

Quy tắc với các nhánh Temp Branches:

Đây là các nhánh nhỏ hơn so với bên trên mà ae có thể tạo ra hàng ngày, hoặc khi theme sau này đã được lên môi trường production rồi. Tuy nhiên thì số lượng nhánh nhỏ nhiều mà không được quản lý prefix + msg sẽ làm ae khó hình dung theme của mình phát triển + sửa đổi sau như thế nào. Nên ae đặt theo prefix này, cũng giống như commit lint trước a cài thôi không có gì cả.

  • Feature: Các tính năng mới chưa có trong phiên bản cũ, giống như là feat mà anh cài trong commitlint:
    • feature/add-product-page
    • feature/add-to-cart-button
  • Bug Fix: Những bug bình thường mà ae hay fix
    • bugfix/fix-responsive-featured-imgage
  • Hot Fix: Những bug quan trọng, có thể ảnh hướng lớn đến theme, cần fix càng sớm càng tốt.
    • hotfix/fix-total-product-count
  • Build: Nhánh chứa các config liên quan đến project
    • build/config-copy-theme-webpack
  • Merging: Nhánh có thể tạo để merge trước 1 vài tính năng, hay bug nhỏ lẻ lại, trước khi ghép toàn bộ vào nhánh dev bên trên.
    • merge/dev_merge-hotfix-total-product

Lưu ý: Mọi nhánh nhỏ chỉ được ghép vào nhánh dev a nhắc bên trên, lấy ra cũng từ nhánh dev, để check code + featured trước khi đưa vào bản chính.

Note:

Commit code

Commitlint Config Conventional

  • build : Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).
  • ci : Changes to our CI configuration files and scripts (example scopes: Gitlab CI, Circle, BrowserStack, SauceLabs).
  • chore : add something without touching production code (Eg: update npm dependencies)
  • docs : Documentation only changes
  • feat : A new feature
  • fix : A bug fix
  • perf : A code change that improves performance
  • refactor : A code change that neither fixes a bug nor adds a feature
  • revert : Reverts a previous commit
  • style : Changes that do not affect the meaning of the code (Eg: adding white-space, formatting, missing semi-colons, etc)
  • test : Adding missing tests or correcting existing tests
git commit -m "fix textfield" # fails
git commit -m "fix: fix textfield" # passes

SCSS

Import

  • Main file only import
  • Trong các folder nhỏ, import scss vào *-dir.scss folder, rồi chỉ import file *-dir.scss ra ngoài main

_utils.scss

@import 'variables.scss' # Sass Variables
@import 'functions.scss' # Sass Functions
@import 'mixins.scss' # Sass Mixins
@import 'helpers.scss' # Class & placeholders helpers

main.scss

/*
* Utils
*/
@import  './utils/utils-dir';

Reset CSS

Reset CSS cho thống nhất default style element trên các Browsers đã được thêm sẵn trong file ./style/vendors/normalize rồi nên không cần viết thêm những cái có sẵn nưa.