stack-builder 0.1.1

A tool that automates the creation of project foundations for multi-tech stacks like Django, React, and MongoDB, generating Dockerfiles, Docker Compose configurations, and more.

STACK-BUILDER

Table of Contents

• Getting Started
  • What is it?
  • Requirements
  • Setup
  • Installation
  • Create Your First Socle
• why use stack-builder?
• LICENSE

---

Getting Started

If you are new to Stack-Builder, this section will guide you through the essential resources to get started.

What is it?

Stack-Builder is an open-source Python package designed to simplify the creation of project foundations (socles). With Stack-Builder, you can easily generate Dockerfiles, Docker Compose configurations, set up database settings, and much more—all with a single command.

Requirements

• Python: Since Stack-Builder is a Python package, you need to install Python. The recommended version is 3.11 or newer.
• Docker CLI: Docker is essential for managing various technologies and their versions efficiently. It resolves compatibility issues that arise when using multiple technologies.

Setup

Step 1: Install Python (Version 3.11 or newer)

• Visit the official Python website to download and install Python for your system.

Step 2: Install Docker

• Go to the official Docker website and select the appropriate version for your system.

Step 3: Create a Virtual Environment with Python and Activate It

For Unix/macOS:

python3 -m venv .env_stack_builder
source .env_stack_builder/bin/activate                

For Windows:

py -m venv .env_stack_builder
.env_stack_builder\Scripts\activate

Step 4: Start Docker

Ensure Docker is running before proceeding.

---

Installation

Install the Stack-Builder package using pip:

For Unix/macOS:

python -m pip install stack-builder

For Windows:

py -m pip install stack-builder

---

Create Your First Socle

Here is an example of creating a project foundation with Django and PostgreSQL as the database. Note that the initial creation of the Django project requires an active internet connection.

Run the following command (works for both Bash and PowerShell) config.yaml:

stack-builder --config config.yaml

This command will:

• Create a Django application.
• Configure PostgreSQL as the database.
• Set up Dockerfiles and Docker Compose configurations for your project.

---

why use stack-builder?

• Easy to use like speak.

• gain tima for fast template.

• open source to keep users consient of project mechanism.

LICENSE

MIT

Enjoy building your project with Stack-Builder! 🚀