Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gowthertg/inception


https://github.com/gowthertg/inception

docker docker-compose docker-container docker-image dockerfile makefile mariadb-mysql ngnix shell-scripting wordpress

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Inception Project

## Table of Contents

- [**About**](#about)
- [**Prerequisites**](#prerequisites)
- [**Getting Started**](#getting-started)
- [**Usage**](#usage)
- [**Project Structure**](#project-structure)
- [**Built With**](#built-with)
- [**Contributing**](#contributing)

## About

This repository contains the Inception project, which is part of the common core curriculum. The project focuses on system administration using Docker and involves setting up a small infrastructure with various services.

## Prerequisites

Before you begin, ensure you have met the following requirements:
- Basic knowledge of Docker is recommended.
- Familiarity with Docker Compose.

## Getting Started

To get started with the project, follow these steps:

1. Clone this repository to your local machine..
2. Review the project guidelines and requirements in the documentation.

## Usage

This project focuses on the creation and configuration of Docker containers for essential services including NGINX, WordPress, and MariaDB. To set up the infrastructure, you can leverage the provided `docker-compose.yml` file and Makefile located within the `srcs` directory.

Please refer to the project's documentation for comprehensive instructions on how to use and configure these containers. Detailed usage guidelines will be provided as part of the project's documentation upon its completion.

## Project Structure

The project directory structure is organized as follows:
```bash
/
├── srcs/
│ ├── requirements/
│ │ ├── mariadb/
│ │ ├── nginx/
│ │ ├── ...
│ ├── docker-compose.yml
│ ├── .env
├── Makefile
├── ...
```

- `srcs/`: Contains configuration files and Docker-related code.
- `Makefile`: Used to automate project setup.
- `docker-compose.yml`: Configuration for Docker services.
- `.env`: Environment variable configuration.

## Built With

This project is built with the following technologies and tools:
- Docker
- Docker Compose

## Contributing

Contributions to this project are welcome! To contribute, follow these steps:
1. Fork the project.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Submit a pull request with a clear description of your changes.