/cservice_template

Template for developing all traditional C++ based services.

Primary LanguageC++

cservice_template

[Build status] [Tests status] [License]

Service for ...

cservice_template is the software designed for ... It is developed based on C++17 and provides easy-to-use API. With cservice_template, users can quickly connect to ..., receive ... data and transmit decision via ....

Table of contents

  1. Overview
  2. Dependencies
  3. Installation
  4. Run
  5. Tests
  6. Release History
  7. Contributing
  8. Support
  9. License
  10. FAQ

1. Overview

A service is a template for proper use by developers within a company. The number of services is constantly growing, however, their base remains unchanged. In the current repository, the author has tried to simplify many routine tasks when creating a new repository, including: automatic code documentation, static analysis, code coverage with Unit-tests, the use of generally accepted company submodules to interact with other services in the system.

2. Dependencies

Basic:

Third-party (for visualization):

3. Installation

The installation procedures in Linux Ubuntu 16.04/14.04 32-bit LTS or Linux Mint 19.* /20. * 64-bit are shown here as examples.

4. Run

Make changes according to task in configuration file.

cd cservice_template
git checkout release

Without visualization: ./scripts/build.sh
With visualization: ./scripts/build-gui.sh

./scripts/run.sh

Or using Qt Creator IDE:

Without visualization: **Projects->Run->.*-c ../cservice_template/cfg/cservice_template.cfg -p /tmp/niias/cservice_template

With visualization:

  • Projects->Build->CMake->GUI->ON->Apply Configuration Changes
  • Projects->Run-> -c ../cservice_template/cfg/cservice_template.cfg -p /tmp/niias/cservice_template

You can find more scripts in scripts/.

5. Tests

6. Release History

7. Contributing

  1. Fork it (http://bb.niias/projects/TOOL/repos/cservice_template/browse).
  2. Read Readme, License, Code of Conduct and Condributing Guidelines.
  3. Create your fix or feature branch (git checkout -b feature/name).
  4. Make changes according to Condributing Guidelines.
  5. Make unit tests.
  6. Build repo and tests.
  7. Correct Readmes for whole directories.
  8. Ensure that it is likely to be merged.
  9. Commit your changes (git add . & git commit -m "Feature. Add wrapper class WrapperClass.").
  10. Push to the branch (git push origin feature/new-wrapper-class)
  11. Create a new Pull Request to develop

8. Support

Reach out to me at one of the following places!

9. License

10. FAQ

JSC NIIAS