Skip to content

Nedaly/ondermax-shopify-theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

262 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Ondermax Shopify Theme

A modern, conversion-optimized Shopify theme built with performance and user experience in mind.

πŸš€ Quick Start

Prerequisites

  • Node.js LTS (via nvm recommended)
  • Shopify CLI
  • Git

Setup

# Clone the repository
git clone [email protected]:YOUR_ORG_OR_USERNAME/ondermax-shopify-theme.git
cd ondermax-shopify-theme

# Install dependencies
npm install

# Set up environment
cp .env.example .env
# Edit .env with your store details

# Login to Shopify
shopify theme login --store ondermax.myshopify.com

# Pull development theme
shopify theme pull --store ondermax.myshopify.com --theme <THEME_ID>

# Start development server
npm run dev

πŸ“‹ Git Flow

This project follows Git Flow branching strategy:

main (production)
β”œβ”€β”€ develop (integration)
β”‚   β”œβ”€β”€ feature/hero-value-prop
β”‚   β”œβ”€β”€ feature/navigation-redesign
β”‚   └── feature/checkout-optimization
β”œβ”€β”€ release/v1.0.0
└── hotfix/critical-bug-fix

Branch Types

  • main: Production-ready code, always deployable
  • develop: Integration branch for features, always stable
  • feature/*: New features developed from develop
  • release/*: Release preparation from develop to main
  • hotfix/*: Critical fixes directly to main

Workflow

  1. Create feature branch from develop
  2. Develop and test locally
  3. Create PR to develop
  4. After review, merge to develop
  5. Create release branch for production deployment

πŸ› οΈ Development Commands

# Development
npm run dev               # Start development server
npm run check             # Run theme-check
npm run push:staging      # Push to staging theme

# Code Quality
npm run format            # Format code with Prettier
npm run format:check      # Check formatting

# Git
git checkout -b feature/your-feature-name
git commit -m "feat(section): add new hero section"

πŸ“ Project Structure

β”œβ”€β”€ assets/              # CSS, JS, images
β”‚   β”œβ”€β”€ application.css
β”‚   β”œβ”€β”€ application.js
β”‚   └── images/
β”œβ”€β”€ config/              # Theme settings
β”‚   └── settings_schema.json
β”œβ”€β”€ layout/              # Base templates
β”‚   └── theme.liquid
β”œβ”€β”€ locales/             # Translation files
β”œβ”€β”€ sections/            # Reusable sections
β”‚   β”œβ”€β”€ hero-value.liquid
β”‚   └── social-proof.liquid
β”œβ”€β”€ snippets/            # Reusable components
β”œβ”€β”€ templates/           # Page templates
β”œβ”€β”€ docs/                # Documentation
β”œβ”€β”€ scripts/             # Development scripts
└── .theme-check.yml     # Theme check configuration

βœ… Definition of Done

Before any feature is considered complete, ensure:

Local Development

  • shopify theme dev runs without errors
  • No console errors in browser
  • All functionality works as expected
  • Responsive design tested on mobile/desktop

Code Quality

  • theme-check passes with no warnings
  • Prettier formatting applied
  • Code follows project conventions
  • Performance impact considered

Testing & QA

  • Pushed as unpublished staging theme
  • Staging environment tested thoroughly
  • Cross-browser compatibility verified
  • Mobile experience validated

Documentation & Process

  • PR created to develop with screenshots
  • PR title references CSV ID: [CSV-HP-003]
  • Staging URL provided for QA
  • Code reviewed and approved

🎯 CRO Focus Areas

Homepage Optimization

  • Clear value proposition above the fold
  • Prominent and compelling CTAs
  • Strategic social proof placement
  • Fast loading and intuitive navigation

Product Experience

  • High-quality product imagery
  • Compelling product descriptions
  • Easy add-to-cart process
  • Related product suggestions

Checkout Optimization

  • Guest checkout available
  • Clear progress indicators
  • Minimal form fields
  • Trust signals throughout

Performance

  • Core Web Vitals optimized
  • Mobile-first approach
  • Image optimization and lazy loading
  • Minimal third-party scripts

πŸ“š Documentation

πŸ”§ Tools & Configuration

Code Quality

  • Prettier: Code formatting
  • Theme Check: Shopify theme validation
  • Husky: Git hooks for quality gates
  • lint-staged: Pre-commit linting

Development

  • Shopify CLI: Theme development and deployment
  • Git Flow: Branching strategy
  • Conventional Commits: Standardized commit messages

πŸš€ Deployment

Staging

# Create release branch
git checkout -b release/v1.0.0

# Push to staging theme
shopify theme push --unpublished --path . --theme "staging-v1.0-rc1"

Production

# Tag release
git tag v1.0.0
git push --tags

# Deploy to production theme
shopify theme push --path . --theme "production"

🀝 Contributing

  1. Follow the Contributing Guidelines
  2. Use conventional commit messages
  3. Include CSV ID in PR titles
  4. Test thoroughly before submitting PR
  5. Provide screenshots and staging URLs

πŸ“ž Support

For questions or issues:


Remember: Every PR must include a CSV ID reference in the title format: [CSV-XXX-###]

About

Ondermax Shopify Theme - Conversion-optimized theme with Git Flow and development tools

Resources

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors