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

Improve readme for contributors & self-hosting #983

Closed
FlxMgdnz opened this issue Aug 22, 2023 · 0 comments
Closed

Improve readme for contributors & self-hosting #983

FlxMgdnz opened this issue Aug 22, 2023 · 0 comments

Comments

@FlxMgdnz
Copy link
Member

FlxMgdnz commented Aug 22, 2023

The root README has a Getting Started section that links you to the README for the backend, which is helpful if you want to run the backend on bare metal. However, most users probably don't want the hassle of trying to run everything on bare metal especially if they don't want to install Postgres/MySQL/Golang locally.

It's not immediately obvious there's a way to run the project entirely from Docker. The documentation on running the Docker stuff is in the deploy section, but this section doesn't appear to be advertised from the root README or the backend docs. I think it'll be good to add a point in the Getting Started section that there's a way to run the project entirely in Docker.

I would recommend the Getting Started section be formatted to offer two ways to run the project:

  • Docker
  • Bare Metal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant