- Node.js version 16.14.0 or higher
Once you have your project cloned start off by installing your node packages
npm install
To run your application locally, you can use Shopify's mock.shop API to simulate a Shopify storefront. You can set the PUBLIC_STORE_DOMAIN environment variable to mock.shop to use the mock.shop API.
SESSION_SECRET="foobar"
PUBLIC_STORE_DOMAIN="mock.shop"
PUBLIC_STOREFRONT_API_TOKEN="foobar"You can automate pull in your Shopify environment variables directly from your Shopify Hydrogen storefront using the Hydrogen CLI. Run the command below and follow its prompts.
npx shopify hydrogen env pull
Alternatively, you can create a .env file and manually copy these values from your Shopify Hydrogen storefront. You can find the variables by going to the Hydrogen storefront > Storefront Settings > Environments & Variables. These are the required variables needed:
SESSION_SECRET="XXX"
PUBLIC_STOREFRONT_API_TOKEN="XXX"
PUBLIC_STORE_DOMAIN="XXX"
PACK_PUBLIC_TOKEN="XXX"
PACK_SECRET_TOKEN="XXX"
PACK_STOREFRONT_ID="XXX"This command will simulate the same deployment job that Shopify Oxygen will use when deploying your live site.
npm run buildThis command will start a server locally on your machine at http://localhost:3000.
npm run devView Pack's developer documentation for info on how to set up and use the platform. Join our Discord community if you get stuck, want to chat, or are thinking of a new feature. Or email us at contact@packdigital.com if Discord isn't your thing. We're here to help - and to make Pack even better!
We ❤ all contributions, big and small! Read our quickstart guide for how to set up your local development environment. The TLDR:
- If there’s a bug, raise an issue
- If you have a fix, fork it and do a PR
- If you have a feature request → Raise it as an issue / discussion, put in a PR if you build it If you want to, you can reach out via Discord or email and we'll set up a pair programming session to get you started.