Skip to content

Commit 7655b1c

Browse files
committed
project restart
1 parent 3697a79 commit 7655b1c

File tree

1 file changed

+218
-0
lines changed

1 file changed

+218
-0
lines changed

luna-commons-api/README.md

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
2+
3+
# ProjectName
4+
5+
luna-commons-api
6+
7+
<!-- PROJECT SHIELDS -->
8+
9+
[![Contributors][contributors-shield]][contributors-url]
10+
[![Forks][forks-shield]][forks-url]
11+
[![Stargazers][stars-shield]][stars-url]
12+
[![Issues][issues-shield]][issues-url]
13+
[![MIT License][license-shield]][license-url]
14+
[![LinkedIn][linkedin-shield]][linkedin-url]
15+
16+
<!-- PROJECT LOGO -->
17+
<br />
18+
19+
<p align="center">
20+
<a href="https://github.com/czy1024/luna-commons/">
21+
<img src="https://user-gold-cdn.xitu.io/2020/7/18/1736060af5cad8d0?w=128&h=128&f=png&s=2312" alt="Logo" width="80" height="80">
22+
</a>
23+
24+
<h3 align="center">"完美的"开发工具</h3>
25+
<p align="center">
26+
市场上许多界面和工具的集合,例如ftp,httpd等文件与工具操作,包括但不限于图像处理、人脸识别等的api。让你免去寻找工具的烦恼
27+
<br />
28+
<a href="https://github.com/czy1024/luna-commons"><strong>探索本项目的文档 »</strong></a>
29+
<br />
30+
<br />
31+
<a href="">查看Demo</a>
32+
·
33+
<a href="">报告Bug</a>
34+
·
35+
<a href="https://github.com/czy1024/luna-commons/issues">提出新特性</a>
36+
</p>
37+
38+
</p>
39+
40+
41+
42+
## 目录
43+
44+
- [上手指南](#上手指南)
45+
- [开发前的配置要求](#开发前的配置要求)
46+
- [安装步骤](#安装步骤)
47+
- [文件目录说明](#文件目录说明)
48+
- [部署](#部署)
49+
50+
51+
### 上手指南
52+
53+
54+
###### **安装步骤**
55+
56+
1. Get a free API Key at [https://account.aliyun.com](https://account.aliyun.com)
57+
2. 找到config目录下的xxxConfigValue,application.properties
58+
3. Clone the repo
59+
60+
```sh
61+
git clone https://github.com/czy1024/luna-commons.git
62+
```
63+
64+
引入项目依赖
65+
66+
```xml
67+
<repositories>
68+
<repository>
69+
<id>luna-commons-mvn-repo</id>
70+
<url>https://raw.github.com/czy1024/luna-commons/mvn-repo-luna-commons-api/</url>
71+
<snapshots>
72+
<enabled>true</enabled>
73+
<updatePolicy>always</updatePolicy>
74+
</snapshots>
75+
</repository>
76+
</repositories>
77+
78+
79+
<dependency>
80+
<groupId>com.luna</groupId>
81+
<artifactId>luna-commons-api</artifactId>
82+
<version>1.0-SNAPSHOT</version>
83+
</dependency>
84+
```
85+
可直接引用api文件目录下的静态方法接口
86+
87+
pom文件
88+
```xml
89+
<?xml version="1.0" encoding="UTF-8"?>
90+
<project xmlns="http://maven.apache.org/POM/4.0.0"
91+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
92+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
93+
<parent>
94+
<artifactId>luna-commons</artifactId>
95+
<groupId>com.luna</groupId>
96+
<version>1.0-SNAPSHOT</version>
97+
</parent>
98+
<modelVersion>4.0.0</modelVersion>
99+
100+
<artifactId>luna-commons-api</artifactId>
101+
102+
<repositories>
103+
<repository>
104+
<id>luna-commons-mvn-repo-api</id>
105+
<url>https://raw.github.com/czy1024/luna-commons/mvn-repo-luna-commons-api/</url>
106+
<snapshots>
107+
<enabled>true</enabled>
108+
<updatePolicy>always</updatePolicy>
109+
</snapshots>
110+
</repository>
111+
</repositories>
112+
113+
<dependencies>
114+
<dependency>
115+
<groupId>com.luna</groupId>
116+
<artifactId>luna-commons-common</artifactId>
117+
<version>1.0-SNAPSHOT</version>
118+
</dependency>
119+
</dependencies>
120+
121+
<build>
122+
<plugins>
123+
<plugin>
124+
<groupId>org.apache.maven.plugins</groupId>
125+
<artifactId>maven-compiler-plugin</artifactId>
126+
<version>3.8.1</version>
127+
<configuration>
128+
<source>8</source>
129+
<target>8</target>
130+
</configuration>
131+
</plugin>
132+
133+
<plugin>
134+
<artifactId>maven-deploy-plugin</artifactId>
135+
<version>2.8.1</version>
136+
<configuration>
137+
<altDeploymentRepository>internal.repo::default::file://${project.build.directory}/mvn-repo
138+
</altDeploymentRepository>
139+
</configuration>
140+
</plugin>
141+
142+
<plugin>
143+
<groupId>com.github.github</groupId>
144+
<artifactId>site-maven-plugin</artifactId>
145+
<version>0.12</version>
146+
<configuration>
147+
<message>Maven artifacts for ${project.version}</message> <!-- git commit message -->
148+
<noJekyll>true</noJekyll> <!-- disable webpage processing -->
149+
<outputDirectory>${project.build.directory}/mvn-repo
150+
</outputDirectory> <!-- matches distribution management repository url above -->
151+
<branch>refs/heads/mvn-repo-luna-commons-api
152+
</branch> <!-- remote branch name -->
153+
<includes>
154+
<include>**/*</include>
155+
</includes>
156+
<repositoryName>luna-commons</repositoryName> <!-- github repo name -->
157+
<repositoryOwner>czy1024</repositoryOwner> <!-- github username -->
158+
</configuration>
159+
<executions>
160+
<!-- run site-maven-plugin's 'site' target as part of the build's normal 'deploy' phase -->
161+
<execution>
162+
<goals>
163+
<goal>site</goal>
164+
</goals>
165+
<phase>deploy</phase>
166+
</execution>
167+
</executions>
168+
</plugin>
169+
</plugins>
170+
</build>
171+
</project>
172+
173+
``
174+
175+
176+
[引用示例见](https://github.com/czy1024/luna-commons/tree/master/luna-commons-baidu)
177+
178+
179+
### 文件目录说明
180+
eg:
181+
182+
```
183+
luna-commons-api
184+
├── README.md
185+
├── src
186+
│ ├── /api/
187+
│──── /resource/
188+
└── pom.xml
189+
190+
```
191+
192+
### 部署
193+
194+
暂无
195+
196+
197+
198+
199+
200+
201+
<!-- links -->
202+
[your-project-path]:czy1024/luna-commons
203+
[contributors-shield]: https://img.shields.io/github/contributors/czy1024/luna-commons.svg?style=flat-square
204+
[contributors-url]: https://github.com/czy1024/luna-commons/graphs/contributors
205+
[forks-shield]: https://img.shields.io/github/forks/czy1024/luna-commons.svg?style=flat-square
206+
[forks-url]: https://github.com/czy1024/luna-commons/network/members
207+
[stars-shield]: https://img.shields.io/github/stars/czy1024/luna-commons.svg?style=flat-square
208+
[stars-url]: https://github.com/czy1024/luna-commons/stargazers
209+
[issues-shield]: https://img.shields.io/github/issues/czy1024/luna-commons.svg?style=flat-square
210+
[issues-url]: https://img.shields.io/github/issues/czy1024/luna-commons.svg
211+
[license-shield]: https://img.shields.io/github/license/czy1024/luna-commons.svg?style=flat-square
212+
[license-url]: https://github.com/czy1024/luna-commons/blob/master/LICENSE.txt
213+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
214+
[linkedin-url]: https://linkedin.com/in/luna-commons
215+
216+
217+
218+

0 commit comments

Comments
 (0)