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: 7 days 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 (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-14T12:50:06.000Z (2 months ago)
• Last Synced: 2025-01-08T00:09:41.793Z (14 days ago)
• Topics: asynchronous, backend, ci, coroutines, cplusplus, cplusplus-17, cpp17, makefile, rest-api, server, template, template-project, test-automation, testing, userver
• Language: Makefile
• Homepage: https://userver.tech/da/d16/md_en_2userver_2tutorial_2hello__service.html
• Size: 104 KB
• Stars: 100
• Watchers: 9
• Forks: 33
• Open Issues: 3
• 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 green "Use this template button" at the top 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 occurences of "service_template" string with that name

4. Feel free to tweak, adjust or fully rewrite the source code of your service.

## Makefile

Makefile contains typicaly useful targets for development:

* `make build-debug` - debug build of the service with all the assertions and sanitizers enabled

* `make build-release` - release build of the service with LTO

* `make test-debug` - does a `make build-debug` and runs all the tests on the result

* `make test-release` - does a `make build-release` and runs all the tests on the result

* `make start-debug` - builds the service in debug mode and starts it

* `make start-release` - builds the service in release mode and starts it

* `make` or `make all` - builds and runs all the tests in release and debug modes

* `make format` - autoformat all the C++ and Python sources

* `make clean-` - cleans the object files

* `make dist-clean` - clean all, including the CMake cached configurations

* `make install` - does a `make build-release` and run install in directory set in environment `PREFIX`

* `make install-debug` - does a `make build-debug` and runs install in directory set in environment `PREFIX`

* `make docker-COMMAND` - run `make COMMAND` in docker environment

* `make docker-build-debug` - debug build of the service with all the assertions and sanitizers enabled in docker environment

* `make docker-test-debug` - does a `make build-debug` and runs all the tests on the result in docker environment

* `make docker-start-release` - does a `make install-release` and runs service in docker environment

* `make docker-start-debug` - does a `make install-debug` and runs service in docker environment

* `make docker-clean-data` - stop docker containers

Edit `Makefile.local` to change the default configuration and build options.

## 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.