Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bigcommerce/catalyst
Catalyst - for Composable Commerce
https://github.com/bigcommerce/catalyst
composable ecommerce headless nextjs
Last synced: about 8 hours ago
JSON representation
Catalyst - for Composable Commerce
- Host: GitHub
- URL: https://github.com/bigcommerce/catalyst
- Owner: bigcommerce
- License: mit
- Created: 2023-02-07T20:48:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:04:13.000Z (2 months ago)
- Last Synced: 2024-10-29T10:57:04.420Z (2 months ago)
- Topics: composable, ecommerce, headless, nextjs
- Language: TypeScript
- Homepage: https://catalyst-demo.site
- Size: 38.7 MB
- Stars: 104
- Watchers: 58
- Forks: 110
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](LICENSE.md)
[](https://github.com/bigcommerce/catalyst/actions/workflows/lighthouse.yml) [](https://github.com/bigcommerce/catalyst/actions/workflows/basic.yml)
**Catalyst** is the composable, fully customizable headless commerce framework for
[BigCommerce](https://www.bigcommerce.com/). Catalyst is built with [Next.js](https://nextjs.org/), uses
our [React](https://react.dev/) storefront components, and is backed by the
[GraphQL Storefront API](https://developer.bigcommerce.com/docs/storefront/graphql).
By choosing Catalyst, you'll have a fully-functional storefront within a few seconds, and spend zero time on wiring
up APIs or building SEO, Accessibility, and Performance-optimized ecommerce components you've probably written many
times before. You can instead go straight to work building your brand and making this your own.
🚀 catalyst.dev •
🤗 BigCommerce Developer Community •
💬 GitHub Discussions •
💡 Docs in this repo
## Deploy on Vercel
The easiest way to deploy your Catalyst Storefront is to use the [Vercel Platform](https://vercel.com/new) from the creators of Next.js.
Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## Quickstart
Create a new project interactively by running:
```bash
npm create @bigcommerce/catalyst@latest
```
You'll then get the following prompts:
```console
? What would you like to call your project? my-faster-storefront
? Which would you like?
❯ Link Catalyst to a BigCommerce Store
Use sample data
? Would you like to create a new channel? y
? What would you like to name the new channel? My Faster Storefront
Success! Created 'my-faster-storefront' at '/Users/first.last/Documents/GitHub/my-faster-storefront'
```
Next steps:
```bash
cd my-faster-storefront && npm run dev
```
Learn more about Catalyst at [catalyst.dev](https://catalyst.dev).
## Resources
- [Catalyst Documentation](https://catalyst.dev/docs/)
- [GraphQL Storefront API Playground](https://developer.bigcommerce.com/graphql-storefront/playground)
- [GraphQL Storefront API Explorer](https://developer.bigcommerce.com/graphql-storefront/explorer)
- [BigCommerce DevDocs](https://developer.bigcommerce.com/docs/build)
> [!IMPORTANT]
> If you just want to build a storefront, start with the [CLI](#quickstart) which will install the Next.js application in [/core](/core/).
> If you wish to contribute back to Catalyst or create a fork of Catalyst, you can check the [docs for this monorepo](https://catalyst.dev/docs/monorepo) to get started.
