Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Installation guide #204

Merged
merged 3 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
48 changes: 48 additions & 0 deletions docs/INSTALLATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Sale Dock - Installation Guide

## I. Install via Docker

### 1. Requirements

- OS: Linux, Windows, macOS
- Docker Desktop: [Install Docker Desktop](https://www.docker.com/products/docker-desktop)

### 2. Installation

- Step 1: Open Docker Desktop

| ![Docker Desktop](../imgs/1.png) |
| :------------------------------: |
| _Image 1: Open Docker Desktop_ |

- Step 2: Open your terminal

| ![Terminal](../imgs/2.png) |
| :---------------------------: |
| _Image 2: Open your terminal_ |

- Step 3: Download `docker-compose.yml` via `curl`

```bash
curl -O https://raw.githubusercontent.com/hardingadonis/saledock/main/docker-compose.yml
```

| ![Download docker compose file](../imgs/3.png) |
| :-------------------------------------------------: |
| _Image 3: Download `docker-compose.yml` via `curl`_ |

- Step 4: Run `docker-compose up -d` and wait for the installation to complete

```bash
docker-compose up -d
```

| ![Run docker compose](../imgs/4.png) |
| :-----------------------------------: |
| _Image 4: Run `docker-compose up -d`_ |

- Step 5: Open your browser and navigate to `http://localhost:8080/saledock`

| ![Open browser](../imgs/5.png) |
| :----------------------------: |
| _Image 5: Open your browser_ |
Binary file added imgs/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading