|
1 | 1 | # fw-commons |
2 | 2 |
|
3 | | -Fw-Commons [a commons Java lib]() with spring boot framework, Supports using keycloak, filter, trace log, cached, minio server, exception handler, validate and call API with webclient |
| 3 | +Fw-Commons [a commons Java lib]() with spring boot framework, Supports using keycloak, filter, trace log, cached, minio |
| 4 | +server, exception handler, validate and call API with webclient |
4 | 5 |
|
5 | | -[](http://www.ponfee.cn) |
6 | | -[](https://www.apache.org/licenses/LICENSE-2.0.html) |
7 | | -[](https://www.oracle.com/java/technologies/downloads/#java21) |
| 6 | +This README provides quickstart instructions on running [`fw-commons`]() on bare metal project spring boot. |
| 7 | + |
| 8 | +[](https://www.opensource.org/licenses/mit-license.php) |
| 9 | +[](https://www.oracle.com/java/technologies/downloads/#java21) |
8 | 10 | [](https://github.com/hoangtien2k3/fw-commons/actions) |
9 | | -[](https://central.sonatype.com/artifact/io.hoangtien2k3/fw-commons/1.1.0) |
| 11 | +[](https://central.sonatype.com/artifact/io.github.hoangtien2k3/fw-commons/1.1.0) |
| 12 | +[](https://central.sonatype.com/artifact/io.github.hoangtien2k3/fw-commons/1.1.0) |
| 13 | + |
| 14 | +### ⬇️ [Download From Gradle and Maven Central](https://central.sonatype.com/artifact/cn.ponfee/commons-core/1.4) |
10 | 15 |
|
11 | | -### ⬇️ [Download From Maven Central](https://central.sonatype.com/artifact/cn.ponfee/commons-core/1.4) |
| 16 | +#### Maven |
12 | 17 |
|
13 | 18 | ```xml |
14 | 19 | <dependency> |
15 | | - <groupId>io.github.hoangtien2k3</groupId> |
16 | | - <artifactId>fw-commons</artifactId> |
17 | | - <version>1.1.0</version> |
| 20 | + <groupId>io.github.hoangtien2k3</groupId> |
| 21 | + <artifactId>fw-commons</artifactId> |
| 22 | + <version>1.1.0</version> |
18 | 23 | </dependency> |
19 | 24 | ``` |
20 | 25 |
|
21 | | -# Using with spring-boot |
| 26 | +#### Gradle |
| 27 | + |
| 28 | +```kotlin |
| 29 | +implementation("io.github.hoangtien2k3:fw-commons:1.1.0") |
| 30 | +``` |
| 31 | + |
| 32 | +## Installation and Getting Started |
| 33 | + |
| 34 | +1. Correct and complete setup to start the program `application.yml` or `application.properties` |
| 35 | + with [CONFIG](src/main/resources/application.yml) |
| 36 | + |
| 37 | +2. The [reference documentation]() includes detailed [installation instructions]() as well as a |
| 38 | + comprehensive [getting started]() guide. |
| 39 | + |
| 40 | +Here is a quick teaser of a complete Spring Boot application in Java: |
22 | 41 |
|
23 | | -## Keycloak: |
| 42 | +```java |
| 43 | +@SpringBootApplication |
| 44 | +@ComponentScan(basePackages = {"io.hoangtien2k3.commons.*"}) |
| 45 | +@ImportResource({"classpath*:applicationContext.xml"}) |
| 46 | +public class Example { |
| 47 | + |
| 48 | + @RequestMapping("/") |
| 49 | + String home() { |
| 50 | + return "Hello World!"; |
| 51 | + } |
| 52 | + |
| 53 | + public static void main(String[] args) { |
| 54 | + SpringApplication.run(Example.class, args); |
| 55 | + } |
| 56 | +} |
| 57 | +``` |
24 | 58 |
|
25 | 59 | ## License |
26 | | -This code is under the [MIT License](LICENSE) |
| 60 | + |
| 61 | +This project is licensed under the [`MIT License`](LICENSE). |
| 62 | + |
| 63 | +```text |
| 64 | +MIT License |
| 65 | +Copyright (c) 2024 Hoàng Anh Tiến |
| 66 | +``` |
| 67 | + |
| 68 | +## Contributors ✨ |
| 69 | + |
| 70 | +<table> |
| 71 | + <tr> |
| 72 | + <td align="center"><a href="https://www.linkedin.com/in/hoangtien2k3/"><img src="https://avatars.githubusercontent.com/u/122768076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hoàng Anh Tiến</b></sub></a><br /><a href="https://github.com/hoangtien2k3/news-app/commits?author=hoangtien2k3" title="Code">💻</a> <a href="#maintenance-hoangtien2k3" title="Maintenance">🚧</a> <a href="#ideas-hoangtien2k3" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-hoangtien2k3" title="Design">🎨</a> <a href="https://github.com/hoangtien2k3/news-app/issues?q=author%hoangtien2k3" title="Bug reports">🐛</a></td> |
| 73 | + </tr> |
| 74 | +</table> |
0 commit comments