From 0323f74cda84702397e3334175300819b913b6ab Mon Sep 17 00:00:00 2001 From: Helen Lin Date: Thu, 4 Nov 2021 15:04:23 -0700 Subject: [PATCH] feat: new main branch --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b974c1 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +![Hydrogen logo](/docs/images/HydrogenLogo.png) + +📚 [Docs](https://shopify.dev/custom-storefronts/hydrogen) | 🗣 [Discord](https://discord.gg/Hefq6w5c5d) | 💬 [Discussions](https://github.com/Shopify/hydrogen/discussions) | 📝 [Changelog](./packages/hydrogen/CHANGELOG.md) + +Hydrogen is a **React-based framework** for building dynamic, **Shopify-powered** custom storefronts. + +Spin up a Hydrogen app in your browser with our [playground](https://hydrogen.new/) or set up your local environment with the instructions below ⬇️ + +## Getting Started + +**Requirements:** + +- `yarn` or `npm` +- Node.js version 14.0 or higher + +**Installation:** + +```bash +# Using `yarn` +yarn create hydrogen-app + +# Using `npm` +npm init hydrogen-app@latest + +# Using `npx` +npx create-hydrogen-app +``` + +**Running locally:** + +1. Start a development server + +```bash +# Using `yarn` +yarn install +yarn dev + +# Using `npm` +npm i --legacy-peer-deps +npm run dev +``` + +2. Visit the development environment running at http://localhost:3000. + +Learn more about [getting started with Hydrogen](https://shopify.dev/custom-storefronts/hydrogen/getting-started). + +## Contributing to Hydrogen + +[Read our contributing guide](./docs/contributing.md) + +## Other handy links + +🎁 Give us the gift of [feedback](https://www.surveymonkey.com/r/HydrogenFeedback). + +📍 Check out [Hydrogen examples on Github](https://github.com/Shopify/hydrogen-examples). + +🤩 [Learn more about Hydrogen](https://shopify.dev/hydrogen). + +👷‍♀️ Add `npm` packages to your project: + +- [`@shopify/hydrogen`](https://www.npmjs.com/package/@shopify/hydrogen) +- [`@shopify/hydrogen-cli`](https://www.npmjs.com/package/@shopify/hydrogen-cli) +- [`@shopify/hydrogen-plugin-sanity`](https://www.npmjs.com/package/@shopify/hydrogen-plugin-sanity) +- [`create-hydrogen-app`](https://www.npmjs.com/package/create-hydrogen-app) +- [`eslint-plugin-hydrogen`](https://www.npmjs.com/package/eslint-plugin-hydrogen) +- [`@shopify/create-hydrogen` (deprecated)](https://www.npmjs.com/package/@shopify/create-hydrogen)