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.

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

Update README with deployment info, etc #79

Merged
merged 5 commits into from
Nov 1, 2022
Merged

Update README with deployment info, etc #79

merged 5 commits into from
Nov 1, 2022

Conversation

jessmartin
Copy link
Contributor

@jessmartin jessmartin commented Oct 28, 2022 •
edited
Loading

Description

Updating the README.

Link to issue

  • Add Deployment instructions for Vercel and Cloudflare Pages
  • Add "experimental software warning"
  • Add supported node versions.

Closes #9.

@vercel
Copy link

vercel bot commented Oct 28, 2022 •
edited
Loading

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

Name Status Preview Updated
webnative-template ✅ Ready (Inspect) Visit Preview Oct 28, 2022 at 4:16PM (UTC)

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 28, 2022 •
edited
Loading

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 449a284
Status: ✅  Deploy successful!
Preview URL: https://46faa7a5.webnative-app-template.pages.dev
Branch Preview URL: https://readme-updates.webnative-app-template.pages.dev

View logs

jessmartin
jessmartin commented Oct 28, 2022
View reviewed changes
README.md

![Webnative UI Screenshot](static/webnative-ui.png)

The Webnative App Template is a clone-and-go template for building a web application using Webnative, fast. Clone, customize, and deploy to have a running distributed app in mere minutes.

<div style="background-color: #FEEB80; padding: 1px 20px; border-radius: 10px;">
Copy link
Contributor Author

@jessmartin jessmartin Oct 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not displaying in the diff properly. It actually looks something like this:
image

Too much?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope that's about right.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The warning box isn't displaying for me when I view the rendered version here: https://github.com/webnative-examples/webnative-app-template/blob/449a28488fe21c6ea696b76684515407ba3a3da0/README.md

@jessmartin jessmartin marked this pull request as ready for review October 28, 2022 16:16
@jessmartin jessmartin requested a review from bgins October 28, 2022 16:16
@jessmartin
Copy link
Contributor Author

@bgins @therealjeffg could one of you review before pod planning today?

jeffgca
jeffgca approved these changes Nov 1, 2022
View reviewed changes
Copy link
Contributor

@jeffgca jeffgca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great - thanks! Assuming all the deployment instructions are correct, 👍🏻

README.md

![Webnative UI Screenshot](static/webnative-ui.png)

The Webnative App Template is a clone-and-go template for building a web application using Webnative, fast. Clone, customize, and deploy to have a running distributed app in mere minutes.

<div style="background-color: #FEEB80; padding: 1px 20px; border-radius: 10px;">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope that's about right.

bgins
bgins reviewed Nov 1, 2022
View reviewed changes
README.md

Ready? Let's go:
Prerequiste: ensure you are running Node 16.14 or greater, but _not_ Node 17 (18 is fine though!).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea to call this out! 💯

bgins
bgins approved these changes Nov 1, 2022
View reviewed changes
Copy link
Member

@bgins bgins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! ✨

One thing I noticed is the links to the Vercel and Cloudflare Pages previews are 404. Are the deploys coming in on another PR?

@jessmartin jessmartin merged commit ba3a90a into main Nov 1, 2022
@jessmartin jessmartin deleted the readme-updates branch November 1, 2022 16:28
@jessmartin
Copy link
Contributor Author

One thing I noticed is the links to the Vercel and Cloudflare Pages previews are 404.

Whoops! One is a bad link, and the other (Cloudflare Pages) had to be deleted because it couldn't be "transferred" to the corporate Cloudflare account. They'll be fixed in a few minutes. 🤦‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bgins bgins bgins approved these changes

@jeffgca jeffgca jeffgca approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support some deployment options out of the box
3 participants
@jessmartin @jeffgca @bgins