Skip to content

Commit 0a30a11

Browse files
authored
Update README.md
1 parent 53ba4b8 commit 0a30a11

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,53 @@
1-
# example-async-api [![Build Status](https://dev.azure.com/lganzzzo/lganzzzo/_apis/build/status/oatpp.example-async-api?branchName=master)](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=16&branchName=master)
1+
# Async API Example [![Build Status](https://dev.azure.com/lganzzzo/lganzzzo/_apis/build/status/oatpp.example-async-api?branchName=master)](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=16&branchName=master)
22

3+
Example project how-to use oatpp asynchronous API.
4+
5+
#### More about oat++:
6+
- Website: [https://oatpp.io](https://oatpp.io)
7+
- Docs: [https://oatpp.io/docs/start](https://oatpp.io/docs/start)
8+
- Oat++ Repo: [https://github.com/oatpp/oatpp](https://github.com/oatpp/oatpp)
9+
10+
## Overview
11+
12+
### Project layout
13+
14+
```
15+
16+
- CMakeLists.txt // project loader script. load and build dependencies
17+
- main/ // main project directory
18+
|
19+
|- CMakeLists.txt // projects CMakeLists.txt
20+
|- src/ // source folder
21+
|- test/ // test folder
22+
23+
```
24+
```
25+
- src/
26+
|
27+
|- controller/ // Folder containing controller where all endpoints are declared
28+
|- dto/ // DTOs are declared here
29+
|- AppComponent.hpp // Service config
30+
|- Logger.hpp // Application Logger
31+
|- App.cpp // main() is here
32+
33+
```
34+
35+
---
36+
37+
### Build and Run
38+
39+
#### Using CMake
40+
41+
```
42+
$ mkdir build && cd build
43+
$ cmake ..
44+
$ make run ## Download, build, and install all dependencies. Run project
45+
46+
```
47+
48+
#### In Docker
49+
50+
```
51+
$ docker build -t example-async-api .
52+
$ docker run -p 8000:8000 -t example-async-api
53+
```

0 commit comments

Comments
 (0)