Skip to content

Commit 230afdf

Browse files
authored
Document project structure in README (#440)
* Document project structure in README Added project structure section with detailed directory layout. * Bump version from 7.1.7 to 7.1.8
1 parent 0523be2 commit 230afdf

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,81 @@ Users can view, add, delete person objects from the database via web UI.
3939
Java 25, Spring Boot 4, Thymeleaf Templates, Hibernate, MySQL or H2 databases supported, Gradle 9,
4040
GKE, Docker, minikube, & kubectl.
4141

42+
## Project Structure
43+
```shell
44+
src
45+
├── integration-test
46+
│   └── java
47+
│   └── com.ironoc.db.controller
48+
│   ├── CustomErrorControllerIntegrationTest.java
49+
│   └── PersonControllerIntegrationTest.java
50+
├── main
51+
│   ├── java
52+
│   │   └── com
53+
│   │   └── ironoc
54+
│   │   └── db
55+
│   │   ├── App.java
56+
│   │   ├── config
57+
│   │   │   └── IronocDbConfig.java
58+
│   │   ├── controller
59+
│   │   │   ├── CustomErrorController.java
60+
│   │   │   ├── PersonController.java
61+
│   │   │   └── VersionController.java
62+
│   │   ├── dao
63+
│   │   │   └── PersonDao.java
64+
│   │   ├── enums
65+
│   │   │   └── DataSourceKey.java
66+
│   │   ├── model
67+
│   │   │   ├── Employer.java
68+
│   │   │   └── Person.java
69+
│   │   └── service
70+
│   │   ├── GoogleCloudClient.java
71+
│   │   ├── GoogleCloudClientImpl.java
72+
│   │   ├── PersonService.java
73+
│   │   └── PersonServiceImpl.java
74+
│   ├── META-INF
75+
│   │   └── MANIFEST.MF
76+
│   └── resources
77+
│   ├── application-h2.properties
78+
│   ├── application.properties
79+
│   ├── db
80+
│   │   ├── data-h2.sql
81+
│   │   ├── data-mysql.sql
82+
│   │   └── ddl.sql
83+
│   ├── log4j.xml
84+
│   ├── static
85+
│   │   ├── favicon.ico
86+
│   │   ├── img
87+
│   │   │   └── robot-logo.png
88+
│   │   ├── ironoc-db-banner.txt
89+
│   │   └── style
90+
│   │   └── main.css
91+
│   └── templates
92+
│   ├── add-employee.html
93+
│   ├── edit-person.html
94+
│   ├── employee-list.html
95+
│   ├── error404.html
96+
│   ├── index.html
97+
│   └── navbar.html
98+
└── test
99+
├── java
100+
│   └── com
101+
│   └── ironoc
102+
│   └── db
103+
│   ├── AppTest.java
104+
│   ├── config
105+
│   │   └── IronocDbConfigTest.java
106+
│   ├── controller
107+
│   │   ├── CustomErrorControllerTest.java
108+
│   │   ├── PersonControllerTest.java
109+
│   │   └── VersionControllerTest.java
110+
│   └── service
111+
│   ├── GoogleCloudClientServiceTest.java
112+
│   └── PersonServiceTest.java
113+
└── resources
114+
└── application.properties
115+
```
116+
42117
## Run
43118
### - See `src/main/resources/db/ddl.sql` for sample Schema to get started with ironoc-db instances using MySQL or H2
44119
```shell

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ sonar {
3737
}
3838

3939
group = 'conorheffron'
40-
version = '7.1.7'
40+
version = '7.1.8'
4141
description = "iRonoc-DB Sample Data Manager"
4242

4343
java {

0 commit comments

Comments
 (0)