Skip to content

Commit 1e5cff5

Browse files
steven300900steven300900
committed
feature: initialize spring boot application
1 parent f6429a8 commit 1e5cff5

File tree

12 files changed

+785
-0
lines changed

12 files changed

+785
-0
lines changed

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# Intellij files
2+
.idea
3+
4+
# Target Files
5+
/target
6+
17
# Compiled class file
28
*.class
39

‎README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Design Documents
2+
https://github.com/acemint/x-admin-backend/docs
3+
4+
# Contributing
5+
## Setup
6+
- Required Java Version JDK 21
7+
- (Optional) - Install podman to run locally
8+
9+
## Commit Convention
10+
THis document outlines how to write commit messages such that it is easier for yourself and others to track what you have changed.
11+
Adapted from [here](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13#examples)
12+
13+
### Commit Format:
14+
```
15+
<type>: <description>
16+
\n
17+
<optional body>
18+
\n
19+
<optional footer>
20+
```
21+
22+
### Examples:
23+
```
24+
feat: add email notifications on new direct messages
25+
```
26+
27+
```
28+
feat: remove ticket list endpoint
29+
30+
refers to JIRA-1337
31+
32+
BREAKING CHANGES: ticket enpoints no longer supports list all entites.
33+
```
34+
35+
### Type
36+
Essentially defines the type of change that is made
37+
- `feat` Commits, that adds or remove a new feature
38+
- `fix` Commits, that fixes a bug
39+
- `refactor` Commits, that rewrite/restructure your code, however does not change any API behaviour
40+
- `perf` Commits are special refactor commits, that improve performance
41+
- `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
42+
- `test` Commits, that add missing tests or correcting existing tests
43+
- `docs` Commits, that affect documentation only
44+
- `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
45+
- `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
46+
- `chore` Miscellaneous commits e.g. modifying .gitignore
47+
48+
### Description
49+
Describe what changed you made in one sentence
50+
51+
- Use the imperative, present tense: "change" not "changed" nor "changes"
52+
- Think of This commit will... or This commit should...
53+
- Don't capitalize the first letter
54+
- No dot (.) at the end
55+
56+
### Body (Optional)
57+
The body should include the motivation for the change and contrast this with previous behavior.
58+
59+
- Use the imperative, present tense: "change" not "changed" nor "changes"
60+
- This is the place to mention issue identifiers and their relations (for example, HCN-1)
61+
62+
### Footer (Optional)
63+
The footer should contain any information about Breaking Changes
64+
65+
- Breaking Changes should start with the word BREAKING CHANGES: followed by space or two newlines. The rest of the commit message is then used for this.

‎docs/erd.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
```mermaid
2+
erDiagram
3+
MS_CLINIC ||--o{ MS_EMPLOYEE : have
4+
MS_CLINIC ||--o{ MS_PATIENT : have
5+
MS_CLINIC ||--o{ MS_TREATMENT : have
6+
MS_CLINIC ||--o{ MS_INVENTORY : have
7+
MS_EMPLOYEE ||--o{ MS_VISIT : confirms
8+
MS_EMPLOYEE ||--o{ MS_CLOCK_IN : creates
9+
MS_PATIENT ||--o{ MS_VISIT : confirms
10+
MS_VISIT ||--o| MS_VISIT_TREATMENT : performs
11+
MS_VISIT_TREATMENT }|--|| MS_TREATMENT : details
12+
13+
MS_CLINIC {
14+
uuid id PK
15+
string code "unique"
16+
int pph21
17+
decimal commissionFee
18+
decimal sittingFee
19+
decimal medicalItemFee
20+
date subscriptionValidFrom
21+
date subscriptionValidTo
22+
int subscriptionTier
23+
}
24+
MS_EMPLOYEE {
25+
uuid id PK
26+
string code "unique"
27+
uuid clinicId FK
28+
string name
29+
string type
30+
string role
31+
string status
32+
decimal salary
33+
}
34+
MS_PATIENT {
35+
uuid id PK
36+
string code "unique"
37+
uuid clinicId FK
38+
string name
39+
}
40+
MS_VISIT {
41+
uuid id PK
42+
uuid patientId FK
43+
uuid employeeId FK
44+
bool cancelled
45+
datetime start
46+
datetime end
47+
}
48+
MS_CLOCK_IN {
49+
uuid id PK
50+
uuid employeeId FK
51+
date clockIn
52+
date clockOut
53+
}
54+
MS_TREATMENT {
55+
uuid id PK
56+
string code "unique"
57+
uuid clinidId FK
58+
string name
59+
int price
60+
}
61+
MS_INVENTORY {
62+
uuid id PK
63+
string code "unique"
64+
uuid clinicId FK
65+
string name
66+
int qty
67+
string status
68+
string uom
69+
date expiryDate
70+
}
71+
MS_VISIT_TREATMENT {
72+
uuid id PK
73+
uuid visitId FK
74+
uuid treatmentId FK
75+
text description
76+
}
77+
```

0 commit comments

Comments
 (0)