{"id":19492799,"url":"https://github.com/oatpp/oatpp-starter-async","last_synced_at":"2025-04-25T20:30:41.969Z","repository":{"id":98398021,"uuid":"131072006","full_name":"oatpp/oatpp-starter-async","owner":"oatpp","description":"oatpp Async-API starter project.","archived":false,"fork":false,"pushed_at":"2024-05-15T23:14:47.000Z","size":677,"stargazers_count":20,"open_issues_count":3,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-29T22:52:06.370Z","etag":null,"topics":["async","cpp","oatpp","starter-project"],"latest_commit_sha":null,"homepage":"https://oatpp.io/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oatpp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-25T22:52:44.000Z","updated_at":"2024-05-15T23:14:51.000Z","dependencies_parsed_at":"2024-11-07T00:25:33.786Z","dependency_job_id":"90644ef7-0a73-4427-8f3f-628fc9f89ad1","html_url":"https://github.com/oatpp/oatpp-starter-async","commit_stats":{"total_commits":49,"total_committers":1,"mean_commits":49.0,"dds":0.0,"last_synced_commit":"d1a2820f9b97941b3844243d9b1b5398bec9237e"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oatpp%2Foatpp-starter-async","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oatpp%2Foatpp-starter-async/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oatpp%2Foatpp-starter-async/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oatpp%2Foatpp-starter-async/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oatpp","download_url":"https://codeload.github.com/oatpp/oatpp-starter-async/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224015660,"owners_count":17241535,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","cpp","oatpp","starter-project"],"created_at":"2024-11-10T21:23:04.321Z","updated_at":"2024-11-10T21:23:05.537Z","avatar_url":"https://github.com/oatpp.png","language":"C++","readme":"# oatpp-starter-async [![Build Status](https://dev.azure.com/lganzzzo/lganzzzo/_apis/build/status/oatpp.oatpp-starter-async?branchName=master)](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=11\u0026branchName=master)\n\nStarter project of oat++ (AKA oatpp) application. Based on oatpp Async API.\n\nSee more:\n\n- [Oat++ Website](https://oatpp.io/)\n- [Oat++ Github Repository](https://github.com/oatpp/oatpp)\n- [Get Started](https://oatpp.io/docs/start)\n\n## Note\n\nAsync API suits best for services dedicated to a single type of tasks that run at high concurrency levels.  \nExample:\n\n- Simultanious download of multiple files.\n- Streaming to large number of clients (1K or more).\n- Chats.\n\nFor all other purposes use [Simple API](https://github.com/oatpp/oatpp-starter).\n\n## Before you start\n\nRead:\n\n- [Simple API vs Async API](https://oatpp.io/docs/simple-vs-async/)\n- [Async](https://oatpp.io/docs/async/)\n- [Oatpp-Coroutines](https://oatpp.io/docs/oatpp-coroutines/)\n- [ENDPOINT_ASYNC](https://oatpp.io/docs/components/api-controller/#endpoint-async-specifics)\n\n## Overview\n\n### Project layout\n\n```\n|- CMakeLists.txt                        // projects CMakeLists.txt\n|- src/\n|    |\n|    |- controller/                      // Folder containing UserController where all endpoints are declared\n|    |- dto/                             // DTOs are declared here\n|    |- AppComponent.hpp                 // Service config\n|    |- App.cpp                          // main() is here\n|    \n|- test/                                 // test folder\n|- utility/install-oatpp-modules.sh      // utility script to install required oatpp-modules.\n```\n\n---\n\n### Build and Run\n\n#### Using CMake\n\n**Requires** \n\n- `oatpp` module installed. You may run `utility/install-oatpp-modules.sh` \nscript to install required oatpp modules.\n\n```\n$ mkdir build \u0026\u0026 cd build\n$ cmake ..\n$ make \n$ ./my-project-exe                  # - run application.\n\n```\n\n#### In Docker\n\n```\n$ docker build -t oatpp-starter-async .\n$ docker run -p 8000:8000 -t oatpp-starter-async\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foatpp%2Foatpp-starter-async","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foatpp%2Foatpp-starter-async","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foatpp%2Foatpp-starter-async/lists"}