Skip to content

yinkakun/leah-gardner-storefront

Repository files navigation

Leah Gardner Storefront

A Gatsby storefront for a Shopify store. Built as a learning project for Shopify and Gatsby integration.

This project is bootstrapped using gatsby-starter-ts

Development

To start the project locally, run:

  1. Set up a Shopify store and get the API keys. I wrote a guide on how to do this here.
  2. Rename the .env.example file to .env.development and add the API keys.
  3. Run yarn to install dependencies.
  4. Run yarn develop to start the application in development mode at http://localhost:8000.

Requirements

  • Node.js >= 14.17
  • Yarn 1 (Classic)

Directory Structure

  • .husky — Husky configuration and hooks.
  • src — Application source code, including pages, components, styles.

Scripts

  • yarn dev — Starts the application in development mode at http://localhost:8000.
  • yarn build — Compile your application and make it ready for deployment.
  • yarn serve — Serve the production build of your site
  • yarn clean — Wipe out the cache (.cache folder).
  • yarn type-check — Validate code using TypeScript compiler.
  • yarn lint — Runs ESLint for all files in the src directory.
  • yarn format — Runs Prettier for all files in the src directory.
  • yarn commit — Run commitizen. Alternative to git commit.

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.

Todo

  • Check for Out of Stock Items and disable Add to Cart button with useEffect.