Skip to content
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

Added Vercel 'auto-deploy' button to embeddable-marketplace-demo README #19

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

MyronKoch-dev
Copy link

Pull Request: Add 'Deploy with Vercel' Button to README

Motivation

To simplify the deployment process and make our marketplace app more accessible, we've added a 'Deploy with Vercel' button to the README. This allows users to deploy the app for free with just a GitHub and Vercel account. Our goal is to streamline onboarding and encourage more users to experience the app without complex setup procedures.

Implementation

  • Added 'Deploy with Vercel' Button: Inserted a markdown snippet in the README.md file that includes a 'Deploy with Vercel' button.

    [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/andromedaprotocol/embeddable-marketplace-demo.git)
    • Functionality: When clicked, this button redirects users to Vercel's import page, preconfigured with our GitHub repository as the template. This enables a seamless, one-click deployment process.
    • Placement: Positioned the button prominently under the 'Getting Started' section to ensure visibility.
  • README Enhancements:

    • Updated instructions to guide users on deploying the app using the new button.
    • Added a brief explanation of the benefits of deploying via Vercel.

Testing

  • Local Testing:

    • Verified the button's functionality by clicking it within the local README.md preview and ensuring it directs to the correct Vercel import page.
    • Confirmed that the deployment process initializes correctly on Vercel, with the repository importing as expected.
  • Deployment Verification:

    • Successfully deployed the app to Vercel using the button to ensure end-to-end functionality.
    • Tested the live application to confirm it operates identically to local deployments.
  • Version Control:

    • No version change was necessary as this update pertains to documentation and does not affect the application's codebase or functionality.

Future Work

  • Add 'Deploy with Replit' Button:

    • Plan to incorporate a similar deployment option using Replit to provide users with alternative hosting solutions.
    • This will further lower the barrier for users who prefer or already use Replit.
  • Investigate Vercel v0 Integration:

    • Explore implementing Vercel v0's new 'codebase import' functionality to enhance our front-end development workflow.
    • Aim to leverage AI-assisted coding features to improve efficiency and code quality.

Notes

  • User Experience Improvement:

    • This addition significantly improves the user experience by reducing setup time and complexity.
    • Encourages more users to try out the marketplace app, potentially increasing adoption and feedback.
  • Documentation Clarity:

    • Enhancements to the README aim to provide clear, concise instructions, making the onboarding process as smooth as possible.
    • Future updates will continue to refine documentation based on user feedback.

Thank you for considering this pull request. I'm excited about the potential this brings to our project in making deployment effortless for our users. Please let me know if there are any suggestions or changes needed. Regards, MK

Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
embeddable-marketplace-demo ✅ Ready (Inspect) Visit Preview Oct 22, 2024 2:15am

@MyronKoch-dev MyronKoch-dev changed the title Added Vercel Auto deploy button to embeddable-marketplace-demo Added Vercel 'auto-deploy' button to embeddable-marketplace-demo Oct 22, 2024
@MyronKoch-dev MyronKoch-dev changed the title Added Vercel 'auto-deploy' button to embeddable-marketplace-demo Added Vercel 'auto-deploy' button to embeddable-marketplace-demo README Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant