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

Quickstart tutorial #5

Merged
merged 8 commits into from
Jan 20, 2021
Merged
Changes from all commits
Commits
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
25 changes: 24 additions & 1 deletion docs/src/content/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
priyanshunayan marked this conversation as resolved.
Show resolved Hide resolved

3. Hydrus demo server is up and running at
```bash
http://localhost:8080/api/vocab
```