Skip to content

Commit f3a8f8e

Browse files
authored
docs: update file structure
1 parent c824a12 commit f3a8f8e

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,23 @@ This is the explanation of our file structure:
1313

1414
```bash
1515
.
16-
├── Makefile <-- Make to automate build
17-
├── domain <-- All domains/entities belong here
18-
├── infra <-- All external framework/drivers for our app to run
19-
├── utils <-- Shared utilities
20-
├── user
16+
├── domain <-- All domains/entities belong here
17+
├── user <-- Module directory
2118
│ └── handler
22-
│ └── hello-world <-- Source code for a lambda function
23-
│ ├── main.go <-- Lambda function code
24-
│ └── main_test.go <-- Unit tests
19+
│ └── user-get <-- Source code for a lambda function
20+
│ ├── main.go <-- Lambda function code
21+
│ └── main_test.go <-- Unit tests
2522
│ └── repository
26-
│ └── mysql_repository <-- Repository for our db
23+
│ ├── mysql_repository.go <-- Repository for our db
24+
│ └── mysql_repository_test.go <-- Unit tests
2725
│ └── usecase
28-
│ └── user_usecase <-- Business rules
29-
└── template.yaml <-- Cloudformation template
26+
│ ├── user_usecase.go <-- Business rules
27+
│ └── user_usecase_test.go <-- Unit tests
28+
29+
├── infra <-- All external framework/drivers
30+
├── utils <-- Shared utilities
31+
├── Makefile <-- Make to automate build
32+
└── template.yaml <-- Cloudformation template
3033
```
3134

3235
## Setup process
@@ -83,4 +86,4 @@ For mocking purpose, we use `gomock` from Golang to help us to generate mock fil
8386
- [https://github.com/bxcodec/go-clean-arch](https://github.com/bxcodec/go-clean-arch)
8487

8588
## TODO
86-
- Resource tagging
89+
- Resource tagging

0 commit comments

Comments
 (0)