Skip to content

Commit 7bc3dfc

Browse files
authored
Update README.md
1 parent c547d4a commit 7bc3dfc

File tree

1 file changed

+21
-26
lines changed

1 file changed

+21
-26
lines changed

README.md

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,35 @@ Example of a production grade entity service storing information in PostgreSQL.
44
*Libpq is used to communicate with PostgreSQL database.*
55
*Dockerfile and docker-compose.yaml files included.*
66

7-
#### More about oat++:
7+
See more:
88

9-
- Website: [https://oatpp.io](https://oatpp.io)
10-
- Docs: [https://oatpp.io/docs/start](https://oatpp.io/docs/start)
11-
- Oat++ Repo: [https://github.com/oatpp/oatpp](https://github.com/oatpp/oatpp)
9+
- [Oat++ Website](https://oatpp.io/)
10+
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
11+
- [Get Started](https://oatpp.io/docs/start)
1212

1313
## Overview
1414

15-
This project is using `oatpp` and `oatpp-swagger` modules.
15+
This project is using [oatpp](https://github.com/oatpp/oatpp) and [oatpp-swagger](https://github.com/oatpp/oatpp-swagger) modules.
1616

1717
### Project layout
1818

1919
```
20-
21-
- CMakeLists.txt // projects CMakeLists.txt
22-
- src/ // source folder
23-
- test/ // test folder
24-
- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
25-
- resources/config.json // configuration file with configuration profiles
26-
- Dockerfile // Dockerfile
27-
- docker-compose.yaml // Docker-compose with this service and postgresql
28-
```
29-
```
30-
- src/
31-
|
32-
|- controller/ // Folder containing Controller where all endpoints are declared
33-
|- db/ // Database class is here
34-
|- dto/ // DTOs are declared here
35-
|- ServiceComponent.hpp // Service configuration (port, ObjectMapper, Database)
36-
|- SwaggerComponent.hpp // Configuration for swagger-ui
37-
|- AppComponent.hpp // Service configuration is loaded here
38-
|- Logger.hpp // Application Logger
39-
|- App.cpp // main() is here
40-
20+
|- CMakeLists.txt // projects CMakeLists.txt
21+
|- src/
22+
| |
23+
| |- controller/ // Folder containing Controller where all endpoints are declared
24+
| |- db/ // Database class is here
25+
| |- dto/ // DTOs are declared here
26+
| |- ServiceComponent.hpp // Service configuration (port, ObjectMapper, Database)
27+
| |- SwaggerComponent.hpp // Configuration for swagger-ui
28+
| |- AppComponent.hpp // Service configuration is loaded here
29+
| |- App.cpp // main() is here
30+
|
31+
|- test/ // test folder
32+
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
33+
|- resources/config.json // configuration file with configuration profiles
34+
|- Dockerfile // Dockerfile
35+
|- docker-compose.yaml // Docker-compose with this service and postgresql
4136
```
4237

4338
---

0 commit comments

Comments
 (0)