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.

Sign up for GitHub

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

Jump to bottom

#11 Added Docker Setup to README #12

Open
wants to merge 1 commit into
base: issue-11-Improve_readme
Choose a base branch
from
Open

#11 Added Docker Setup to README #12

wants to merge 1 commit into from

Conversation

NimishVerma
Copy link

@NimishVerma NimishVerma commented Jul 21, 2020 •
edited
Loading

Issue #11

@NimishVerma NimishVerma mentioned this pull request Jul 21, 2020
Open
@nymann
Copy link
Contributor

nymann commented Jul 21, 2020

Thanks for your contribution @NimishVerma ! 🥂

Should we specify that via make run the same is achieveable?
And maybe link to a docker setup guide?

@nymann nymann added the documentation Improvements or additions to documentation label Jul 21, 2020
@nymann nymann linked an issue Jul 21, 2020 that may be closed by this pull request
Improve readme #11
Open
@nymann nymann self-requested a review July 21, 2020 09:15
nymann
nymann requested changes Jul 21, 2020
View reviewed changes
README.md

#### Documentation
Checkout out or [ReDoc](https://api.chessdb.dev/redoc) documentation, or
[Swagger UI](https://api.chessdb.dev/redoc) to try out the API in action.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't add whitespaces here, you can fix this automatically by installing pre-commit hooks via make hooks.

README.md
@@ -7,11 +7,19 @@
Current popular solutions costs alot of money and only works with their own
client. ChessDB wants to provide a client agnostic solution that's easily
implementable.
#### Setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have separate sections for Windows and GNU/Linux?

I am not sure if it's a good idea to also describe both the native method of setting up (running Postgres locally).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nymann nymann nymann requested changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve readme
2 participants
@NimishVerma @nymann