From 2c40d7e70746c60a8c80178672a52452783b2e92 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Minh=20V=C6=B0=C6=A1ng?= <hardingadonis@gmail.com>
Date: Sat, 20 Jan 2024 18:31:32 +0700
Subject: [PATCH] Add README.md and config for contributors

---
 .all-contributorsrc |  7 ++++
 README.md           | 78 +++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 83 insertions(+), 2 deletions(-)
 create mode 100644 .all-contributorsrc

diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 0000000..94f459d
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,7 @@
+{
+    "projectName": "saledock",
+    "projectOwner": "hardingadonis",
+    "files": ["README.md"],
+    "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
+    "contributors": []
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index 622b775..9ff41ab 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,76 @@
-# saledock
-SWP391 project, ERP system, Sales module
+# 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)
+[![CodeFactor](https://www.codefactor.io/repository/github/hardingadonis/saledock/badge)](https://www.codefactor.io/repository/github/hardingadonis/saledock)
+![GitHub contributors](https://img.shields.io/github/contributors/hardingadonis/saledock)
+![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
+
+
+## Requirements
+- JDK 17
+- MySQL 8.2.0
+- Tomcat 10
+- Maven 3+
+
+
+## Database
+<details>
+  <summary>Database</summary>
+
+  <div style="margin-top: 20px">
+    <a href="https://github.com/hardingadonis/saledock">
+      <img src="database/database.svg"/>
+    </a>
+  </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.
+
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- 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).
\ No newline at end of file