diff --git a/.gitignore b/.gitignore index e750817..59dd348 100644 --- a/.gitignore +++ b/.gitignore @@ -39,6 +39,4 @@ server/*.war # IntelliJ IDEA .idea/ -.history/ - -*.xlsx \ No newline at end of file +.history/ \ No newline at end of file diff --git a/README.md b/README.md index 9c1541b..3afcd02 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Sale Dock + [![build](https://github.com/hardingadonis/saledock/actions/workflows/build.yml/badge.svg)](https://github.com/hardingadonis/saledock/actions/workflows/build.yml) [![publish](https://github.com/hardingadonis/saledock/actions/workflows/publish.yml/badge.svg)](https://github.com/hardingadonis/saledock/actions/workflows/publish.yml) [![release](https://github.com/hardingadonis/saledock/actions/workflows/release.yml/badge.svg)](https://github.com/hardingadonis/saledock/actions/workflows/release.yml) @@ -7,17 +8,18 @@ ![GitHub top language](https://img.shields.io/github/languages/top/hardingadonis/saledock) ![GitHub repo size](https://img.shields.io/github/repo-size/hardingadonis/saledock) ![GitHub License](https://img.shields.io/github/license/hardingadonis/saledock) -> SWP391 project, ERP system, Sales module +> SWP391 project, ERP system, Sales module ## Requirements + - JDK 17 - MySQL 8.2.0 - Tomcat 10 - Maven 3+ - ## Database +
Database @@ -28,37 +30,33 @@
- ## Development + - You need to install the requirements above. + #### 1. Clone `Sale Dock`: + ```bash git clone https://github.com/hardingadonis/saledock.git ``` + #### 2. Open `Sale Dock`: + - You can open `Sale Dock` with your favorite IDE: - [IntelliJ IDEA](https://www.jetbrains.com/idea/) - [Eclipse](https://www.eclipse.org/) - [NetBeans](https://netbeans.apache.org/) + #### 3. Build `Sale Dock` with `Maven` (Optional): + ```bash cd saledock mvn verify ``` - ## Deployment -#### 1. Download `docker-compose.yml`: -```bash -curl -O https://raw.githubusercontent.com/hardingadonis/saledock/main/docker-compose.yml -``` -#### 2. Run `docker-copmose`: -```bash -docker-compose up -d -``` -#### 3. Access `Sale Dock`: -- Open `http://localhost:8080/saledock` in your browser. +- Open Installation Guide: [Installation Guide](docs/INSTALLATION_GUIDE.md) ## Contributors @@ -93,7 +91,7 @@ docker-compose up -d - ## Licenses: + - [Sale Dock](https://github.com/hardingadonis/saledock) is under the [Apache-2.0 license](https://github.com/hardingadonis/saledock/blob/main/LICENSE). -- [favicon](https://github.com/hardingadonis/saledock/blob/main/src/main/webapp/assets/images/favicon/favicon.png) is under the [flaticon](https://www.flaticon.com/free-icon/sale_791968). \ No newline at end of file +- [favicon](https://github.com/hardingadonis/saledock/blob/main/src/main/webapp/assets/images/favicon/favicon.png) is under the [flaticon](https://www.flaticon.com/free-icon/sale_791968). diff --git a/docs/INSTALLATION_GUIDE.md b/docs/INSTALLATION_GUIDE.md new file mode 100644 index 0000000..e30a47e --- /dev/null +++ b/docs/INSTALLATION_GUIDE.md @@ -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_ | diff --git a/docs/SWP391 - Final Release.pdf b/docs/SWP391 - Final Release.pdf new file mode 100644 index 0000000..debbd27 Binary files /dev/null and b/docs/SWP391 - Final Release.pdf differ diff --git a/docs/SWP391 - Issues Report.xlsx b/docs/SWP391 - Issues Report.xlsx new file mode 100644 index 0000000..d3b158e Binary files /dev/null and b/docs/SWP391 - Issues Report.xlsx differ diff --git a/docs/SWP391 - Project Tracking.xlsx b/docs/SWP391 - Project Tracking.xlsx new file mode 100644 index 0000000..8aa569f Binary files /dev/null and b/docs/SWP391 - Project Tracking.xlsx differ diff --git a/docs/SWP391 - Software Design Specification.pdf b/docs/SWP391 - Software Design Specification.pdf new file mode 100644 index 0000000..88ac03b Binary files /dev/null and b/docs/SWP391 - Software Design Specification.pdf differ diff --git a/docs/SWP391 - System Test.xlsx b/docs/SWP391 - System Test.xlsx new file mode 100644 index 0000000..df63f88 Binary files /dev/null and b/docs/SWP391 - System Test.xlsx differ diff --git a/docs/SaleDock_SRS_v1.0.pdf b/docs/SaleDock_SRS_v1.0.pdf new file mode 100644 index 0000000..eb7e810 Binary files /dev/null and b/docs/SaleDock_SRS_v1.0.pdf differ diff --git a/imgs/1.png b/imgs/1.png new file mode 100644 index 0000000..f0f9606 Binary files /dev/null and b/imgs/1.png differ diff --git a/imgs/2.png b/imgs/2.png new file mode 100644 index 0000000..3e9fdb7 Binary files /dev/null and b/imgs/2.png differ diff --git a/imgs/3.png b/imgs/3.png new file mode 100644 index 0000000..b2c7a7c Binary files /dev/null and b/imgs/3.png differ diff --git a/imgs/4.png b/imgs/4.png new file mode 100644 index 0000000..0ca5f5b Binary files /dev/null and b/imgs/4.png differ diff --git a/imgs/5.png b/imgs/5.png new file mode 100644 index 0000000..38c650f Binary files /dev/null and b/imgs/5.png differ