Skip to content

Add hosting config file(s) to project scaffolding #234

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.

Sign up for GitHub

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

Jump to bottom
Closed
sulco opened this issue Aug 9, 2024 · 2 comments
Closed

Add hosting config file(s) to project scaffolding #234

sulco opened this issue Aug 9, 2024 · 2 comments
Labels
cli enhancement New feature or request

Comments

@sulco
Copy link
Member

sulco commented Aug 9, 2024

Is your feature request related to a problem?

Because of CORS headers, deploying TutorialKit requires additional settings for each hosting provider.

Although we document that in https://tutorialkit.dev/guides/deployment/, not everyone reads the manual;) and I've heard feedback from users who'd tripped over the deployment story because of that.

Describe the solution you'd like.

With configuration files dedicated to the most common hosting providers, we can remove friction from deploying a tutorial project, so that aspects like setting up the build command or or headers is automatically taken care of.

Additionally, having this as a step in the wizard will highlight to a user the deployment capability itself.

Describe alternatives you've considered.

We could configure all the "usual suspects" automatically, but making it an additional step in the wizard might be a better option as it will reduce the unnecessary files generated.

Additional context

We can start with Vercel, Netlify and Cloudflare Pages to cover the range we have in our docs: https://tutorialkit.dev/guides/deployment/
@AriPerkkio AriPerkkio added enhancement New feature or request cli labels Aug 9, 2024
@AriPerkkio
Copy link
Member

If we could detect when these CORS errors happen, maybe we should show huge error modal on the UI?

RonithManikonda added a commit that referenced this issue Nov 7, 2024
@RonithManikonda
feat(scaffolding): add hosting config files for common providers
ac47667 
add configuration files for Vercel, Netlify, and Cloudflare Pages to simplify deployment and address CORS header issues in TutorialKit. This improves the setup experience by automating build commands and headers for common hosting providers, reducing manual configuration steps.

close #234
RonithManikonda added a commit that referenced this issue Dec 19, 2024
@RonithManikonda
feat(cli): move hosting configuration generation to dedicated file
2c062e9 
moved the `generateHostingConfig` function to a new file with improved imports for hosting provider configuration files (`vercel.json`, `netlify.toml`, `_headers`). updated the function to work with the new imports and streamlined configuration generation.

this change reduces clutter in the main implementation file and improves modularity by isolating hosting-related logic.

closes #234
RonithManikonda added a commit that referenced this issue Jan 9, 2025
@RonithManikonda
feat(wizard): restrict hosting provider selection to a single option
986ec67 
Adjusted the project scaffolding wizard to allow users to select only one hosting provider at a time, laying the groundwork for improved deployment configuration.

Related to #234
RonithManikonda added a commit that referenced this issue Feb 27, 2025
@RonithManikonda
fix(cli): add 'skip' option and update defaults for hosting config
4df1fc6 
close #234
RonithManikonda added a commit that referenced this issue Mar 5, 2025
@RonithManikonda
chore(prettier): fix formatting errors
edd717d 
Fixes Prettier errors to pass tests and ensure consistent code style.

close #234
RonithManikonda added a commit that referenced this issue Mar 12, 2025
@RonithManikonda
feat(cli): add provider flag to hosting config prompt
af74cd9 
closes #234
RonithManikonda added a commit that referenced this issue Mar 13, 2025
@RonithManikonda
chore(prettier): fix formatting errors
facf7d2 
close #234
RonithManikonda added a commit that referenced this issue Mar 19, 2025
@RonithManikonda
fix(cli): ensure --no-provider skips hosting config prompt
7c45e6e 
closes #234
RonithManikonda added a commit that referenced this issue Mar 19, 2025
@RonithManikonda
chore(prettier): fix formatting errors
bbc7ec9 
close #234
RonithManikonda added a commit that referenced this issue Mar 19, 2025
@RonithManikonda
chore(prettier): fix formatting errors
13103d9 
close #234
@AriPerkkio
Copy link
Member

Fixed by #440.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cli enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sulco @AriPerkkio