Skip to content

Commit bb98aa8

Browse files
committed
docs: 📝 updated describe project structure
1 parent 24b440f commit bb98aa8

File tree

1 file changed

+38
-30
lines changed

1 file changed

+38
-30
lines changed

README.md

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,42 +14,50 @@ We welcome contributions! Please see our [Contributing Guidelines](docs/CONTRIBU
1414

1515
```sh
1616
.
17-
├── api # http openapi schema
17+
├── api # openapi schema
1818
│   └── openapi.yaml
19+
├── build # docker files
20+
│   ├── docker-compose.stage.yml
21+
│   ├── docker-compose.yml
22+
│   └── Dockerfile
1923
├── cmd # main app
20-
│   └── ctf01d
21-
│   └── main.go
24+
│   └── main.go
25+
├── configs # app config and other config (linter)
26+
│   ├── config.development.yml
27+
│   ├── config.production.yml
28+
│   ├── config.test.yml
29+
│   ├── golangci
30+
│   │   └── golangci.yml
31+
│   └── spectral
32+
│   └── spectral.yaml
2233
├── docs # project documentation
2334
│   └── *.md
24-
├── configs
25-
│   └── *.yml
26-
├── build # docker files
27-
│   └── *.yml
28-
├── html
35+
├── html # current frontend
2936
├── internal
30-
│   └── app
31-
│   ├── db
32-
│   │   ├── *.go
33-
│   ├── handlers # backend handlers
34-
│   │   ├── *.go
35-
│   ├── logger
36-
│   │   └── logger.go
37-
│   ├── migrations # sql migrations
38-
│   │   └── psql
39-
│   │   ├── struct_updater.go
40-
│   │   └── update*.go
41-
│   ├── repository # work with db, query ...
42-
│   │   ├── *.go
43-
│   ├── server # autogenerated code from oapi-codegen
44-
│   │   └── server.gen.go
45-
│   ├── utils # shared code
46-
│   │   └── helpers.go
47-
│   └── view # api json template
48-
│   └── *.go
37+
│   ├── config
38+
│   │   └── config.go
39+
│   ├── handler # backend handlers
40+
│   │   └── *.go
41+
│   ├── helper # shared code
42+
│   │   └── helper.go
43+
│   ├── logger
44+
│   │   └── logger.go
45+
│   ├── migrations # sql migrations
46+
│   │   └── psql
47+
│   │   ├── struct_updater.go
48+
│   │   └── update*.go
49+
│   ├── model # api json template
50+
│ │ └── *.go
51+
│   ├── repository # work with db, query ...
52+
│ │ └── *.go
53+
│   ├── server # autogenerated code from oapi-codegen
54+
│   │   ├── html_spa.go
55+
│   │   └── server.gen.go
56+
│   └── view
57+
│   └── session.go
4958
├── pkg
50-
│   └── avatar
51-
│   └── avatar.go # uniq pic for user
52-
├── README.md
59+
│   └── avatar # uniq pic for user
60+
│   └── avatar.go
5361
├── scripts
5462
│   └── create-migration.go # make new file for migration
5563
└── test

0 commit comments

Comments
 (0)