https://github.com/becomevocal/catalyst-makeswift-wordpress-example
https://github.com/becomevocal/catalyst-makeswift-wordpress-example
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/becomevocal/catalyst-makeswift-wordpress-example
- Owner: becomevocal
- License: mit
- Created: 2025-04-09T13:05:38.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-28T18:11:32.000Z (about 2 months ago)
- Last Synced: 2025-05-09T18:58:16.245Z (about 1 month ago)
- Language: TypeScript
- Size: 30.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
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
⚠️ **IMPORTANT:** As of January 6, 2025, the `main` branch is frozen. The default branch is now `canary`. Please make sure to work with and submit PRs to the `canary` branch.
[](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.
## Demo
- [Catalyst Demo](https://catalyst-demo.site)
🚀 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.
