Skip to content

Commit 9bcb3ac

Browse files
committed
Adding project structure to README
1 parent 96705d5 commit 9bcb3ac

File tree

2 files changed

+45
-5
lines changed

2 files changed

+45
-5
lines changed

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
setup.dev:
1+
app.setup:
22
docker-compose build
33

4-
dev.run:
4+
app.run:
55
docker-compose up app
66

7-
dev.stop:
7+
app.stop:
88
docker-compose stop app
99

10-
infra.up:
10+
db.up:
1111
docker-compose up -d db
1212

13-
infra.stop:
13+
db.stop:
1414
docker-compose stop db
1515

1616
migrate:

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Setting up the project
2+
3+
### Step 1
4+
5+
6+
## Swagger
7+
```
8+
http://localhost:8000/swagger/index.html
9+
```
10+
11+
## Project structure
12+
13+
```
14+
├── api
15+
│ ├── handler
16+
├── cmd
17+
├── docs
18+
├── internal
19+
│ ├── config
20+
│ ├── entity
21+
│ ├── infrastructure
22+
│ │ ├── database
23+
│ │ ├── repository
24+
│ ├── usecase
25+
│ │ ├── account
26+
│ │ ├── operation_type
27+
│ │ ├── transaction
28+
├── migrations
29+
├── pkg
30+
│ ├── clock
31+
├── .env.example
32+
├── .gitignore
33+
├── build.sh
34+
├── docker-compose.yml
35+
├── Dockerfile
36+
├── go.mod
37+
├── Makefile
38+
├── README.md
39+
└── reflex.conf
40+
```

0 commit comments

Comments
 (0)