Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gvatsal60/cppdockermaketemplate

🐳🔨 Effortlessly containerize your C++ projects with Docker using this streamlined template
https://github.com/gvatsal60/cppdockermaketemplate

c cpp docker docker-container docker-image dockerfile linux make makefile

Last synced: 10 days ago
JSON representation

🐳🔨 Effortlessly containerize your C++ projects with Docker using this streamlined template

Host: GitHub
URL: https://github.com/gvatsal60/cppdockermaketemplate
Owner: gvatsal60
License: apache-2.0
Created: 2024-05-10T12:18:39.000Z (8 months ago)
Default Branch: master
Last Pushed: 2024-12-17T05:58:28.000Z (12 days ago)
Last Synced: 2024-12-17T06:30:55.210Z (12 days ago)
Topics: c, cpp, docker, docker-container, docker-image, dockerfile, linux, make, makefile
Language: Makefile
Homepage:
Size: 57.6 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# CppDockerMakeTemplate

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://img.shields.io/github/license/gvatsal60/CppDockerMakeTemplate)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/gvatsal60/CppDockerMakeTemplate/build.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gvatsal60_CppDockerMakeTemplate&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gvatsal60_CppDockerMakeTemplate)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-green.svg)](https://GitHub.com/gvatsal60/CppDockerMakeTemplate/graphs/commit-activity)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/gvatsal60/CppDockerMakeTemplate.svg)](https://GitHub.com/gvatsal60/CppDockerMakeTemplate/pull/)
[![GitHub issues](https://img.shields.io/github/issues/gvatsal60/CppDockerMakeTemplate.svg)](https://GitHub.com/gvatsal60/CppDockerMakeTemplate/issues/)
[![GitHub forks](https://img.shields.io/github/forks/gvatsal60/CppDockerMakeTemplate.svg)](https://GitHub.com/gvatsal60/CppDockerMakeTemplate/network/)
[![GitHub stars](https://img.shields.io/github/stars/gvatsal60/CppDockerMakeTemplate.svg)](https://GitHub.com/gvatsal60/CppDockerMakeTemplate/stargazers)

This repository serves as a template for setting up a development environment to run C++ code inside Docker containers using Makefiles. Whether you're working on a personal project or a team-based endeavor,
this template streamlines the process of containerizing your C++ applications, making them portable and easy to manage across different environments.

## Prerequisites

Before getting started, ensure that you have the following prerequisites installed on your system:

- Docker: Install Docker according to the instructions for your operating system from [Docker's official website](https://www.docker.com/get-started).
- Git: Install Git if you haven't already from [Git's official website](https://git-scm.com/downloads).
- Make:

- **Linux:** If you're on a Linux system, Make might already be installed. If not, you can install it using your package manager. For example, on Ubuntu, you can install Make with the following command:

```sh
sudo apt-get install make
```

- **Windows:** For Windows users, Make is not typically installed by default. You can install it using MinGW, which provides a Unix-like environment on Windows along with a collection of GNU utilities.
Follow these steps to install Make on Windows using MinGW:
1. Download and install MinGW from [MinGW's official website](http://www.mingw.org/).
2. During installation, make sure to select the option to install the "MSYS Basic System" component, which includes Make.
3. After installation, add the MinGW bin directory to your system's PATH environment variable. This is typically `C:\MinGW\bin`.

## Getting Started

Follow these steps to get started with CppDockerMakeTemplate:

1. **Clone the Repository:**

```Makefile
git clone https://github.com/gvatsal60/CppDockerMakeTemplate.git
cd CppDockerMakeTemplate
```

2. **Build the Docker Image:**

```Makefile
make build_img
```

3. **Inside the Docker Container:**
Once inside the Docker container, you'll find yourself in the `$PROJECT_NAME` directory, where the project is set up.

4. **Build the Project:**

```Makefile
make build
```

5. **Run the Executable:**

```Makefile
make run
```

6. **Test the Project:**

```Makefile
make test
```

7. **Clean the Project:**

```Makefile
make clean
```

## Customization

You can customize this template according to your project's needs. Here are some areas you might want to modify:

- **Makefile:** Adjust Make configuration, add or remove source files, libraries, or dependencies as needed.
- **Dockerfile:** Modify Dockerfile to include additional packages or tools required for your project.
- **Source Files:** Add your source files under the `src` directory.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

## License

This project is licensed under the Apache 2.0 License. See the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) file for details.

## Acknowledgments

Thank you for using the CppDockerMakeTemplate. Happy coding!