Skip to content

Commit 2b4779f

Browse files
authored
Update README.md
1 parent df6348b commit 2b4779f

1 file changed

Lines changed: 32 additions & 2 deletions

File tree

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# ivory-cloud
2-
IvorySQL management platform. Database lifecycle management, including databases and commonly used tools.
1+
# Installation
2+
3+
## Installation instructions
4+
5+
As an open-source backend project, ivory-cloud requires the local installation of git, jdk, maven, etc., during the development process.
6+
7+
Fork the backend repository of the open-source cloud platform to your own GitHub account, then clone it to your local machine, for example:
8+
9+
```sh
10+
YOUR_GITHUB_UN="<your GitHub username>"
11+
git clone "git@github.com:${YOUR_GITHUB_UN}/ivory-cloud.git"
12+
```
13+
14+
Enter the project root directory:
15+
16+
```
17+
cd ivory-cloud
18+
```
19+
20+
21+
## Deployment
22+
23+
### Compile and build
24+
25+
Maven:Maven configuration is required,After configuration, execute the following command:
26+
27+
```
28+
mvn clean
29+
mvn install
30+
```
31+
After the packaging is completed, you can find the `pkg` directory in the root directory of the project. It contains the jar package to be deployed.
32+
### Deploy backend projects

0 commit comments

Comments
 (0)