Skip to content

Commit

Permalink
feat: new main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
wizardlyhel committed Nov 4, 2021
0 parents commit 0323f74
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 0323f74

Please sign in to comment.