Skip to content

Commit bda4caf

Browse files
committed
feat: initial template
1 parent e93a819 commit bda4caf

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# {{cookiecutter.app_title}}
2+
3+
## Pre-requisite
4+
5+
- maven >= 3.8.6
6+
- open jdk 21
7+
8+
## How to build ?
9+
10+
```
11+
mvn clean install
12+
```
13+
14+
### How to build a docker image ?
15+
16+
```
17+
cd bootstrap && mvn compile jib:dockerBuild
18+
```
19+
20+
[More information](https://cloud.google.com/java/getting-started/jib)
21+
22+
## How to start ?
23+
24+
```
25+
cd bootstrap && mvn spring-boot:run
26+
```
27+
28+
## Formatting
29+
30+
This project uses [git-code-format-maven-plugin](https://github.com/Cosium/git-code-format-maven-plugin) for formatting
31+
the code per [google style guide](https://google.github.io/styleguide/javaguide.html)
32+
33+
### How to format ?
34+
35+
`mvn git-code-format:format-code`
36+
37+
## Validating
38+
39+
This project uses [githook-maven-plugin](https://mvnrepository.com/artifact/io.github.phillipuniverse/githook-maven-plugin) which is a maven plugin to configure and install local git hooks by running set of commands during build.
40+
41+
### Command to validate formatted code
42+
43+
```
44+
mvn git-code-format:validate-code-format
45+
```
46+
47+
## Contribution guidelines
48+
49+
We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.
50+
51+
Request you to please read our [contribution guidelines](https://devs-from-matrix.github.io/basic-template-repository/#/README?id=contribution-guidelines)

0 commit comments

Comments
 (0)