Add sample how-to to the documentation with link to sample repositories

[Yshayy]

• [ ] Sample full stack apps
• [ ] CLI sample (wrapped with ttyd or other similar tool)

[karthiknadar1204]

@Yshayy I would like to work on this issue if it is still up for grabs, could you elaborate what exactly do we have to do here

[Yshayy]

Yes @karthiknadar1204, thanks for contributing. We would like to show an example of a full stack application that is using compose. To show the benefits or Preevy, it's best if the application will consist of an app that:

• Has several Docker services
• At least one service that require build step
• A frontend that can be accessible It could be a bootstrap, or a simple clone app (https://github.com/MasterBrian99/Awesome-Clone) which uses compose file (or we can add one), but it's important that a Preevy experience would work out of the box. Also, ideally the app won't be too complex or slow to build, so it can run properly without any tweaks. (it's possible to test it on local Kubernetes cluster with Preevy Kubernetes driver). Once we have this example (which resides in a different repository), we can add this example to Preevy documentation (on this repo)

The other sample that I mention is creating a preview environment for a CLI app, the idea is to create a compose file that uses ttyd (https://github.com/tsl0922/ttyd) to open a web-terminal preview for a CLI application. Once we have an example, we can also put in our documentation as well. This specific example is interesting as it can be applied for preevy repo as well in the future since Preevy is a CLI.

Let me know if it's clear and makes sense.

[karthiknadar1204]

ok so like using a real project and how to integrate it with prevy in a step by step process ,right @Yshayy ?

[Yshayy]

Pretty much

[karthiknadar1204]

Will get down to doing it,was returning back home from college..

[royra]

See https://github.com/livecycle/preevy-gha-gce-demo for a (partial) example.