Skip to content

#11 Added Docker Setup to README #12

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

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@nymann nymann Jul 21, 2020

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).

For setting up ChessDB API using Docker, the following sets of command have to be executed (Make sure you have already installed Docker Engine and Docker Compose) :
```shell
git clone https://github.com/chessdb.api
cd api
cp .example.env .env
docker-compose up -d
```

#### 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

@nymann nymann Jul 21, 2020

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.



#### Contributing
Expand Down