-
Notifications
You must be signed in to change notification settings - Fork 58
DEVDOCS-6691 - Add catalyst deploying overview #1204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
23 changes: 23 additions & 0 deletions
23
docs/storefront/catalyst/getting-started/deploying/overview.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Deploying a Catalyst storefront | ||
|
|
||
| The Catalyst engineering team tests Catalyst against Vercel in normal development, but Catalyst is a standard Next.js application which can be hosted on most infrastructure providers that support Next.js. Consider the Next.js documentation or your hosting provider's documentation for guidance on how to deploy to your provider of choice. | ||
|
|
||
| Catalyst depends on the following Next.js features which must be supported by your hosting provider: | ||
|
|
||
| * [Incremental Static Regeneration (ISR)](https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration) | ||
| * [Data Cache](https://nextjs.org/docs/app/building-your-application/caching#data-cache) | ||
| * [Partial Prerendering (PPR)](https://nextjs.org/docs/app/building-your-application/rendering/partial-prerendering) | ||
chris-nowicki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * [Middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware) | ||
chris-nowicki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Environment Variables | ||
|
|
||
| Regardless of where or how you deploy your Catalyst application, you'll need to get an updated set of environment variables to use. Assuming you've already run your application locally (follow the [Local Development](https://www.catalyst.dev/docs/local-development) guide for details), you can use the majority of the environment variables defined in your your `env.local` file. | ||
chris-nowicki marked this conversation as resolved.
Show resolved
Hide resolved
chris-nowicki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| However, there are a couple of environment variables that need to be updated. Make sure to check the documentation for each one on how to update them accordingly. | ||
|
|
||
| * [`AUTH_SECRET`](/docs/storefront/catalyst/development/environment-variables#auth_secret) | ||
| * [`BIGCOMMERCE_STOREFRONT_TOKEN`](/docs/storefront/catalyst/development/environment-variables#bigcommerce_storefront_token) | ||
| * [`MAKESWIFT_SITE_API_KEY`](/docs/storefront/catalyst/development/environment-variables#makeswift_site_api_key) | ||
| * [`TURBO_REMOTE_CACHE_SIGNATURE_KEY`](/docs/storefront/catalyst/development/environment-variables#turbo_remote_cache_signature_key) | ||
|
|
||
| For a full list of environment variables, refer to the [environment variables documentation](/docs/storefront/catalyst/development/environment-variables). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.