Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/oatpp-starter
Oatpp simple-API starter project
https://github.com/oatpp/oatpp-starter
cpp oatpp simple starter-project
Last synced: 3 days ago
JSON representation
Oatpp simple-API starter project
- Host: GitHub
- URL: https://github.com/oatpp/oatpp-starter
- Owner: oatpp
- License: apache-2.0
- Created: 2018-04-25T22:52:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T23:13:25.000Z (6 months ago)
- Last Synced: 2024-10-29T22:53:49.066Z (15 days ago)
- Topics: cpp, oatpp, simple, starter-project
- Language: C++
- Homepage: https://oatpp.io/
- Size: 717 KB
- Stars: 72
- Watchers: 5
- Forks: 36
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oatpp-starter [](https://dev.azure.com/lganzzzo/lganzzzo/_build/latest?definitionId=10&branchName=master)
Starter project of oat++ (AKA oatpp) application. Based on oatpp Multithreaded (Simple) API.
See more:
- [Oat++ Website](https://oatpp.io/)
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
- [Get Started](https://oatpp.io/docs/start)
## Overview
### Project layout
```
|- CMakeLists.txt // projects CMakeLists.txt
|- src/
| |
| |- controller/ // Folder containing MyController where all endpoints are declared
| |- dto/ // DTOs are declared here
| |- AppComponent.hpp // Service config
| |- App.cpp // main() is here
|
|- test/ // test folder
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
```
---
### Build and Run
#### Using CMake
**Requires**
- `oatpp` module installed. You may run `utility/install-oatpp-modules.sh`
script to install required oatpp modules.
```
$ mkdir build && cd build
$ cmake ..
$ make
$ ./my-project-exe # - run application.
```
#### In Docker
```
$ docker build -t oatpp-starter .
$ docker run -p 8000:8000 -t oatpp-starter
```