Getting Started / How to Run the App Locally

Pre-Requirements

1. You must download and install Node.js if you don't already have it.
2. You must create a Shopify partner account if you don’t have one.
3. You must create a development store if you don’t have one.

Running a local version of this app

1. Read the Main Product Readme: Familiarise yourself with the project by reading the main Product Readme.

2. Clone the Repository: Clone this repository to your local machine.

3. Create Environment File: In the /web folder of the project, create a .env file.

4. Install Dependencies: Run the following commands to install all necessary dependencies:

yarn install
cd web
yarn install
cd frontend
yarn install

5. Build the Database: Execute the command:

yarn build:db

6. Install Shopify CLI: Ensure that the Shopify CLI is installed on your system.

7. Run the App: Start the application with the command:

yarn dev --reset

8. Connect to Shopify: Follow the on-screen instructions to input your Shopify details for connecting the application.

9. Update Environment File: After the app is connected and installed on your Shopify store, update the .env file with the newly generated SHOPIFY_API_KEY and SHOPIFY_API_SECRET_KEY from the Shopify Partners App Settings. Also, grant permissions for the app to access protected customer data.

10. Restart the Application: Restart the app and run:

yarn dev

11. Configure Webhooks Locally:

• Copy the App URL generated each time the server starts from the Shopify Partners App Configuration.
• Insert this URL into subscribe-to-webhook.js:

const address = `${AppUrlFromShopify}/api/webhooks`;

Useful Resources

• Main Product Readme
• Database Overview
• Deployment Strategy