https://github.com/userver-framework/service_template
Template of a C++ service that uses userver framework. Build, test and CI scripts ready
https://github.com/userver-framework/service_template
asynchronous backend ci coroutines cplusplus cplusplus-17 cpp17 makefile rest-api server template template-project test-automation testing userver
Last synced: about 1 month ago
JSON representation
Template of a C++ service that uses userver framework. Build, test and CI scripts ready
- Host: GitHub
- URL: https://github.com/userver-framework/service_template
- Owner: userver-framework
- Created: 2022-02-06T19:18:39.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-13T07:29:51.000Z (2 months ago)
- Last Synced: 2025-03-29T04:04:27.054Z (about 2 months ago)
- Topics: asynchronous, backend, ci, coroutines, cplusplus, cplusplus-17, cpp17, makefile, rest-api, server, template, template-project, test-automation, testing, userver
- Language: CMake
- Homepage: https://userver.tech/da/d16/md_en_2userver_2tutorial_2hello__service.html
- Size: 108 KB
- Stars: 103
- Watchers: 9
- Forks: 34
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# service_template
Template of a C++ service that uses [userver framework](https://github.com/userver-framework/userver).
## Download and Build
To create your own userver-based service follow the following steps:
1. Press the "Use this template button" at the top right of this GitHub page
2. Clone the service `git clone your-service-repo && cd your-service-repo && git submodule update --init`
3. Give a proper name to your service and replace all the occurrences of "service_template" string with that name
4. Feel free to tweak, adjust or fully rewrite the source code of your service.
## Makefile
`PRESET` is either `debug`, `release`, or if you've added custom presets in `CMakeUserPresets.json`, it
can also be `debug-custom`, `release-custom`.
* `make cmake-PRESET` - run cmake configure, update cmake options and source file lists
* `make build-PRESET` - build the service
* `make test-PRESET` - build the service and run all tests
* `make start-PRESET` - build the service, start it in testsuite environment and leave it running
* `make install-PRESET` - build the service and install it in directory set in environment `PREFIX`
* `make` or `make all` - build and run all tests in `debug` and `release` modes
* `make format` - reformat all C++ and Python sources
* `make dist-clean` - clean build files and cmake cache
* `make docker-COMMAND` - run `make COMMAND` in docker environment
* `make docker-clean-data` - stop docker containers
## License
The original template is distributed under the [Apache-2.0 License](https://github.com/userver-framework/userver/blob/develop/LICENSE)
and [CLA](https://github.com/userver-framework/userver/blob/develop/CONTRIBUTING.md). Services based on the template may change
the license and CLA.