Skip to content

Latest commit

 

History

History
133 lines (97 loc) · 3.31 KB

README.md

File metadata and controls

133 lines (97 loc) · 3.31 KB

Nuxt 3 Commerce

A Nuxt 3 starter template for creating a custom frontend with Shopify's Storefront API. This template sets up a powerful e-commerce site using Nuxt 3, TailwindCSS, and other essential tools to integrate seamlessly with Shopify's API.

Features

Getting Started

Cloning the Repository

  1. Clone the repository using:

    git clone https://github.com/muneebbug/nuxt3-commerce.git
  2. Navigate into the project directory:

    cd nuxt3-commerce

Installation

  1. Install the project dependencies:

    pnpm install

Running the Application

  1. Start the development server:

    pnpm run dev

    The application will be available at http://localhost:3000.

  2. Build the application for production:

    pnpm run build
  3. Generate static files:

    pnpm run generate
  4. Preview the production build:

    pnpm run preview

Additional Scripts

  • Post-install: Prepare the project after installing dependencies:

    pnpm run postinstall

To-Do

  • Nuxt 3
  • Shopify Storefront API Client
  • Tailwind CSS
  • Sass
  • Headless UI
  • ShadCN Nuxt
  • Adding Pinia
    • auto import folder "stores"
  • Eslint & Prettier
  • 🌙 Theme Switcher (light, dark, system)
  • 🇮🇩 Language Switcher
  • Pages
    • Home
    • Collection
    • Product
    • Cart
    • Blog
      • Article
  • 📦 Components
    • Ecommerce Components
      • Hero
      • Collection List
      • Product List
      • Product Card
      • Featured Product
      • Product Details
    • General Components
      • Button
      • Form
    • Modal
    • Drawers
    • Tabs

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes. Ensure to follow the coding standards and include tests for your modifications.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

For questions or support, please open an issue on the GitHub repository. Feel free to adjust the URLs and content as needed!