Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 3.01 KB

README.md

File metadata and controls

55 lines (43 loc) · 3.01 KB
Raw

timetable_vsu_backend

This C++ service use userver framework.

Download and Build

Steps to use this service:

  1. Clone the service
  2. Initialize submodules: cd timetable_vsu_backend && git submodule update --init
  3. Use one of make commands

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 service-start-debug - builds the service in debug mode and starts it
  • make service-start-release - builds the service in release mode and starts it
  • make install-debug - builds the service in debug mode and install it
  • make install-release - builds the service in release mode and install it
  • make run-debug - runs installed debug service
  • make run-release - runs installed release service
  • make install-run-debug - builds the service in debug mode install and run it
  • make install-run-release - builds the service in release mode install and run it
  • make or make all - builds and runs all the tests in release and debug modes
  • make format-all - autoformat all the C++ and Python sources
  • make format-cpp - autoformat all the C++ 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 gen - regenerate source lists for CMake in .gen
  • make check-format-cpp - сheck formatting in C++ sources, if something is not formatted, an error will be returned
  • make check-pep8 - сheck formatting in Python sources, if something is not formatted, an error will be returned
  • make check-format-all - сheck formatting in all sources, if something is not formatted, an error will be returned
  • make unite-api - create united api file(merged_api.yaml)
  • make check-git-status - сheck if there are changes in files
  • make testsuite-debug F='somestring' - does a make build-debug and runs all the python tests on the result which are filtred by 'somestring'
  • make testsuite-release F='somestring' - does a make build-debug and runs all the python tests on the result which are filtred by 'somestring'

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

Known issues

Clangd doesn't working with project

Use ln -s build_debug/compile_commands.json compile_commands.json

License

The original template is distributed under the Apache-2.0 License and CLA.