sergeyklay / cpp-project-template

Repository Templates for C++ Projects

Boilerplate for C++ projects

This repository contains my personal boilerplate for C++ projects.

You can generate a new repository with the same directory structure and files as an existing repository. For more see:

• Creating a repository from a template

Features

• Sources, headers and mains separated in distinct folders
• Modern CMake for much easier compiling
• Continuous testing with GitHub Actions on all modern platforms, with support for C++17.
• Setup for tests using Google's C++ test framework
• x86 and x64 builds
• Code coverage reports, including automatic upload to Codecov.io
• Code documentation with Doxygen
• Create releases and attach artifacts using GitHub Actions

Project Structure and Tools

• Source: multiple files
• Type: Shared Library (so on Linux, dylib on macOS and dll on Windows) with Pimpl implementation
• C++ version: C++17
• Tested OS: Linux, macOS and Windows
• C++ compiler: GCC, Clang, Apple Clang or Visual Studio
• Package manager: Conan
• Build system: CMake
• Libraries: STL, sqlite3, spdlog
• Formatting tools: clang-format
• Static analysis tools: Cpplint, Cppcheck
• CI: GitHub Actions

Getting Started

See docs/GettingStarted.md for more.

License

This project is open source software licensed under the Apache License 2.0. See the LICENSE file for more information.