From d760adbd715c78b19884ac62bd9888e76358ec76 Mon Sep 17 00:00:00 2001 From: Purvansh Singh <49719371+Purvanshsingh@users.noreply.github.com> Date: Wed, 20 Jan 2021 17:14:53 +0530 Subject: [PATCH] Quickstart tutorial - first draft (#5) * Created Quickstart Guide. * typo fixed * update quickstart.md * Custom API Documentation section added. * Font size fix * custom API Doc removed. * Added required changes. * typo fixed. --- docs/src/content/quickstart.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/src/content/quickstart.md b/docs/src/content/quickstart.md index 5852a83..da78a6c 100644 --- a/docs/src/content/quickstart.md +++ b/docs/src/content/quickstart.md @@ -4,4 +4,27 @@ name: Quickstart # Quickstart Guide -This will lead you to different paths. +This Quickstart tutorial will guide you to setup the Hydrus server, we will be using docker in this tutorial, +Therefore you can go through the [Docker container engine](https://docker-curriculum.com/). +## Requirements +* Install [git](https://git-scm.com/downloads) +* Make sure you have [docker-compose](https://docs.docker.com/compose/install/) installed in your system + +## Running hydrus server + +1. Getting the [hydrus repository](https://github.com/HTTP-APIs/hydrus) +```bash +git clone https://github.com/HTTP-APIs/hydrus.git +``` +2. Change directory and run docker-compose +```bash +cd hydrus + +docker-compose up --build +``` +> If you are using linux you may have to use sudo command with docker + +3. Hydrus demo server is up and running at +```bash +http://localhost:8080/api/vocab +``` \ No newline at end of file