Template of a C++ service that uses userver framework.
To create your own userver-based service follow the following steps:
- Press the green "Use this template button" at the top of this github page
- Clone the service
git clone your-service-repo && cd your-service-repo && git submodule update --init
- Give a proper name to your service and replace all the occurences of "service_template" string with that name
- Feel free to tweak, adjust or fully rewrite the source code of your service.
Makefile contains typicaly useful targets for development:
make build-debug
- debug build of the service with all the assertions and sanitizers enabledmake build-release
- release build of the service with LTOmake test-debug
- does amake build-debug
and runs all the tests on the resultmake test-release
- does amake build-release
and runs all the tests on the resultmake service-start-debug
- builds the service in debug mode and starts itmake service-start-release
- builds the service in release mode and starts itmake
ormake all
- builds and runs all the tests in release and debug modesmake format
- autoformat all the C++ and Python sourcesmake clean-
- cleans the object filesmake dist-clean
- clean all, including the CMake cached configurationsmake install
- does amake build-release
and run install in directory set in environmentPREFIX
make install-debug
- does amake build-debug
and runs install in directory set in environmentPREFIX
make docker-COMMAND
- runmake COMMAND
in docker environmentmake docker-build-debug
- debug build of the service with all the assertions and sanitizers enabled in docker environmentmake docker-test-debug
- does amake build-debug
and runs all the tests on the result in docker environmentmake docker-start-service-release
- does amake install-release
and runs service in docker environmentmake docker-start-service-debug
- does amake install-debug
and runs service in docker environmentmake docker-clean-data
- stop docker containers
Edit Makefile.local
to change the default configuration and build options.
The original template is distributed under the Apache-2.0 License and CLA. Services based on the template may change the license and CLA.