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

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

Open
2 tasks
Yshayy opened this issue May 2, 2023 — with Volta.net · 6 comments
Open
2 tasks

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

Yshayy opened this issue May 2, 2023 — with Volta.net · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

Copy link
Contributor

Yshayy commented May 2, 2023

  • Sample full stack apps
  • CLI sample (wrapped with ttyd or other similar tool)
@Yshayy Yshayy added the documentation Improvements or additions to documentation label May 2, 2023 — with Volta.net
@karthiknadar1204
Copy link

@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
Copy link
Contributor Author

Yshayy commented Jul 25, 2023

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
Copy link

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

@Yshayy
Copy link
Contributor Author

Yshayy commented Aug 2, 2023

Pretty much

@karthiknadar1204
Copy link

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

@royra
Copy link
Collaborator

royra commented Aug 9, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

3 participants