zhuagenborn/cpp-project-template

🏗️ A C++ project template built with Docker, Makefile, CMake, GoogleTest and GitHub Actions.

C++ Project Template

Introduction

A C++ project template on Ubuntu built with:

• Docker
• CMake
• Make
• GitHub Actions
• GoogleTest

Building with CMake

Prerequisites

• Install GoogleTest.
• Install CMake.

Building

Go to the project folder and run:

mkdir -p build
cd build
cmake ..
cmake --build .

Running Tests

Go to the build folder and run:

ctest -VV

Running the Main Program

Go to the build/bin folder and run:

./cpp-sample

Building with Docker

Prerequisites

• Install Docker.

Building

Go to the project folder and run the following command to create an image:

docker image build . -t <image>

<image> should be replaced with a custom Docker image name.

Running Tests

docker container run <image> ctest --test-dir .. -VV

Running the Main Program

docker container run <image>

Building with Make

Currently Makefile does not support GoogleTest.

Building

Go to the project folder and run:

make

Running the Main Program

Go to the build folder and run:

./cpp-sample

Structure

.
├── .github
│   └── workflows
│       └── build-test.yaml
├── cmake
│   └── hello.cmake
├── docs
│   └── badges
│       ├── C++.svg
│       ├── Linux.svg
│       ├── Made-with-CMake.svg
│       ├── Made-with-Make.svg
│       ├── Made-with-Docker.svg
│       ├── Made-with-GitHub-Actions.svg
│       └── PowerShell.svg
├── include
│   └── foo
│       └── foo.h
├── src
│   ├── foo
│   │   ├── CMakeLists.txt
│   │   ├── foo.cpp
│   │   ├── private_foo_test.cpp
│   │   ├── private_foo.cpp
│   │   └── private_foo.h
│   ├── CMakeLists.txt
│   └── main.cpp
├── tests
│   ├── CMakeLists.txt
│   └── foo_test.cpp
├── .clang-format
├── .gitignore
├── Build-CMake.ps1
├── CITATION.cff
├── CMakeLists.txt
├── Dockerfile
├── Makefile
└── README.md