DannyCarlton / osBible.org

Open Source Bible Project
GNU General Public License v3.0
5 stars 1 forks source link

Add Examples directory with one-click deploy examples of implementations #2

Open ThatGuySam opened 5 months ago

ThatGuySam commented 5 months ago

A popular pattern I've seen to make repos easier to navigate and get a working example running is to use a /examples directory

at the root with One-click buttons for Vercel and/or Netlify

Examples of this pattern

These give Devs that are new to the repo prebuilt templates that may or may not have familiar tools so that they can start with code and configuration that's already been vetted to "just work"

Another pattern I've seen is One-click deploy buttons like these: Deploy with Vercel

This is just a button in Markdown that links to a hosting service to start up a given example within a few minutes removing even more friction from getting started with the tools.

Here are the respective articles for adding Deploy buttons for JavaScript apps:

With online IDEs



For the PHP and SQL examples, Digital Ocean would be a good deploy target: Deploy to DO

Digital Ocean - https://docs.digitalocean.com/products/app-platform/how-to/add-deploy-do-button/

There's also Laravel Forge which is a very popular solution for PHP applications, but I can't seem to find a deploy button for them.

DannyCarlton commented 5 months ago

I'll look in to this. Unfortunately a lot of the newer JavaScript based languages are out of my wheelhouse. I was hoping someone more familiar with them could volunteer to make examples.

However, I can try to make a PHP/MySQL/Ajax deployment button.

I'm also working on an Open Source version of https://myOpenBible.org that would serve as a live, working example.