Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bsamseth/cpp-project
Boiler plate template for C++ projects, with CMake, Doctest, Travis CI, Appveyor, Github Actions and coverage reports.
https://github.com/bsamseth/cpp-project
actions boilerplate cmake code-coverage code-review codecov coveralls cpp cpp-17 doctest folder-structure github-actions project-template template-project travis-ci
Last synced: about 24 hours ago
JSON representation
Boiler plate template for C++ projects, with CMake, Doctest, Travis CI, Appveyor, Github Actions and coverage reports.
- Host: GitHub
- URL: https://github.com/bsamseth/cpp-project
- Owner: bsamseth
- License: unlicense
- Created: 2016-03-01T07:02:30.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T12:15:35.000Z (about 1 year ago)
- Last Synced: 2024-11-21T10:44:28.172Z (21 days ago)
- Topics: actions, boilerplate, cmake, code-coverage, code-review, codecov, coveralls, cpp, cpp-17, doctest, folder-structure, github-actions, project-template, template-project, travis-ci
- Language: CMake
- Homepage:
- Size: 157 KB
- Stars: 602
- Watchers: 18
- Forks: 128
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeCppGameDev - cpp-project
README
[](http://www.repostatus.org/#active)
[](https://travis-ci.org/bsamseth/cpp-project)
[](https://ci.appveyor.com/project/bsamseth/cpp-project/branch/master)
[](https://coveralls.io/github/bsamseth/cpp-project?branch=master)
[](https://codecov.io/gh/bsamseth/cpp-project)
[](https://www.codacy.com/app/bsamseth/cpp-project?utm_source=github.com&utm_medium=referral&utm_content=bsamseth/cpp-project&utm_campaign=Badge_Grade)
[](https://lgtm.com/projects/g/bsamseth/cpp-project/context:cpp)
[](https://lgtm.com/projects/g/bsamseth/cpp-project/alerts/)
[](https://github.com/bsamseth/cpp-project/blob/master/LICENSE)
[](https://github.com/Aaronepower/tokei)
[](http://isitmaintained.com/project/bsamseth/cpp-project "Average time to resolve an issue")
[](http://isitmaintained.com/project/bsamseth/cpp-project "Percentage of issues still open")
# Boiler plate for C++ projects
This is a boiler plate for C++ projects. What you get:
- Sources, headers and mains separated in distinct folders
- Use of modern [CMake](https://cmake.org/) for much easier compiling
- Setup for tests using [doctest](https://github.com/onqtam/doctest)
- Continuous testing with [Travis-CI](https://travis-ci.org/), [Appveyor](https://www.appveyor.com) and [GitHub Actions](https://github.com/features/actions), with support for C++17.
- Code coverage reports, including automatic upload to [Coveralls.io](https://coveralls.io/) and/or [Codecov.io](https://codecov.io)
- Code documentation with [Doxygen](http://www.stack.nl/~dimitri/doxygen/)
## Structure
``` text
.
├── CMakeLists.txt
├── app
│ └── main.cpp
├── include
│ ├── example.h
│ └── exampleConfig.h.in
├── src
│ └── example.cpp
└── tests
├── dummy.cpp
└── main.cpp
```
Sources go in [src/](src/), header files in [include/](include/), main programs in [app/](app), and
tests go in [tests/](tests/) (compiled to `unit_tests` by default).
If you add a new executable, say `app/hello.cpp`, you only need to add the following two lines to [CMakeLists.txt](CMakeLists.txt):
```cmake
add_executable(main app/main.cpp) # Name of exec. and location of file.
target_link_libraries(main PRIVATE ${LIBRARY_NAME}) # Link the executable to lib built from src/*.cpp (if it uses it).
```
You can find the example source code that builds the `main` executable in [app/main.cpp](app/main.cpp) under the `Build` section in [CMakeLists.txt](CMakeLists.txt).
If the executable you made does not use the library in [src/](src), then only the first line is needed.
## Building
Build by making a build directory (i.e. `build/`), run `cmake` in that dir, and then use `make` to build the desired target.
Example:
```bash
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=[Debug | Coverage | Release]
make
./main
make test # Makes and runs the tests.
make coverage # Generate a coverage report.
make doc # Generate html documentation.
```
## .gitignore
The [.gitignore](.gitignore) file is a copy of the [Github C++.gitignore file](https://github.com/github/gitignore/blob/master/C%2B%2B.gitignore),
with the addition of ignoring the build directory (`build/`).
## Services
If the repository is activated with Travis-CI, then unit tests will be built and executed on each commit.
The same is true if the repository is activated with Appveyor.
If the repository is activated with Coveralls/Codecov, then deployment to Travis will also calculate code coverage and
upload this to Coveralls.io and/or Codecov.io
## Setup
### Using the GitHub template
Click the `Use this template` button to make a new repository from this template.
### From command line
When starting a new project, you probably don't want the history of this repository. To start fresh you can use
the [setup script](setup.sh) as follows:
```bash
git clone https://github.com/bsamseth/cpp-project # Or use ssh-link if you like.
cd cpp-project
bash setup.sh
```
The result is a fresh Git repository with one commit adding all files from the boiler plate.