Getting Started

This guide will help you set up and run your Shopify app using the Vue.js template.

Quick Start

Follow these simple steps to get your Shopify app up and running:

1. Clone the repository

   # Option 1: Using degit (recommended)
   npx degit Mini-Sylar/shopify-app-vue-template your-app-name
   
   # Option 2: Using git clone
   git clone https://github.com/Mini-Sylar/shopify-app-vue-template.git your-app-name

2. Install dependencies

   cd your-app-name
   npm install

3. Configure your app (first time only)

   npm run dev:reset

   This will guide you through setting up your Shopify app credentials.

4. Start the development server

   npm run dev

5. Access your app Open the URL shown in your terminal to view your app.

Available Scripts

The template includes several useful scripts to streamline your development process:

Command	Description
npm run shopify	Run Shopify CLI commands
npm run build	Build the project (frontend and backend)
npm run dev	Start the development server
npm run dev:reset	Reset Shopify configuration
npm run dev:webhook	Trigger a webhook
npm run info	Display info about the Shopify app
npm run generate	Generate a theme extension
npm run deploy	Deploy the app
npm run show:env	Show environment variables for production
npm run lint	Run ESLint on the entire project
npm run format:server	Run Prettier formatting on the server
npm run format:client	Run Prettier formatting on the client

For the complete list of commands, check your package.json file.

Next Steps

After setting up your app, you can:

1. Explore the Features included in the template
2. Learn about Internationalization
3. Check out what's new in Version 2.0

If you run into any issues, refer to our comprehensive FAQ section.