From 4df3ef629fe91350c8267ef294f703ff14d96da6 Mon Sep 17 00:00:00 2001 From: Nimish Date: Tue, 21 Jul 2020 00:08:33 -0400 Subject: [PATCH] Updated README.md with Docker Instructions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a399813..6231e27 100644 --- a/README.md +++ b/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 +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. - + #### Contributing