bytechef icon indicating copy to clipboard operation
bytechef copied to clipboard

[docs]: Basic setup in README

Open F1nn-T opened this issue 1 year ago • 1 comments

Documentation Link

https://github.com/bytechefhq/bytechef/blob/master/README.md

Describe the problem

As a new user of ByteChef, I would like to be able to get a running instance on my system.

Describe the improvement

I think that it would be good to add a "Getting Started" section in the README file, describing how to run ByteChef so that users can try it. This shouldn't replace the Contribution section on setting up the system, but rather be a quick guide on how to get a running system for someone who wants to use the ByteChef without contributing.

F1nn-T avatar Aug 05 '24 12:08 F1nn-T

I think that we need to create a new Dockerfile for this improvement as well, which not only runs the databases and the server but also the client.

F1nn-T avatar Aug 05 '24 12:08 F1nn-T

Getting Started section is already covered in the README.md, though. In the docs page, however, not so much. If this is an issue, I'd like to work on it.

spartanns avatar Oct 09 '24 14:10 spartanns

The Readme.md got updated in the meantime. Thanks

F1nn-T avatar Oct 18 '24 10:10 F1nn-T