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

Commit

Permalink
upload documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hardingadonis committed Mar 22, 2024
1 parent a607764 commit 9d46bd1
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 19 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,4 @@ server/*.war
# IntelliJ IDEA
.idea/

.history/

*.xlsx
.history/
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

<details>
<summary>Database</summary>

Expand All @@ -28,37 +30,33 @@
</div>
</details>


## 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

Expand Down Expand Up @@ -93,7 +91,7 @@ docker-compose up -d

<!-- ALL-CONTRIBUTORS-LIST:END -->


## 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).
- [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).
Binary file added docs/SWP391 - Final Release.pdf
Binary file not shown.
Binary file added docs/SWP391 - Issues Report.xlsx
Binary file not shown.
Binary file added docs/SWP391 - Project Tracking.xlsx
Binary file not shown.
Binary file added docs/SWP391 - Software Design Specification.pdf
Binary file not shown.
Binary file added docs/SWP391 - System Test.xlsx
Binary file not shown.
Binary file added docs/SaleDock_SRS_v1.0.pdf
Binary file not shown.

0 comments on commit 9d46bd1

Please sign in to comment.