DeployStack

DeployStack is a full-stack deployment orchestration platform that seamlessly integrates with GitHub to automatically fetch, deploy, and manage your repositories. It features a responsive Flutter-based frontend for monitoring deployments, a powerful Node.js backend, and relies on MongoDB and Apache Kafka to handle robust asynchronous event messaging.

🚀 Features

• GitHub Integration: Authorize via GitHub Apps to fetch repositories, setup webhooks, and seamlessly link your codebases.
• Continuous Deployment (CI/CD): Deploy a repository by specifying a target branch. Every time you push a newly crafted commit to that branch, DeployStack instantly rebuilds the project and pushes the updates live in real-time!
• Asynchronous Architecture: Uses Apache Kafka to process build triggers and deployment events securely and reliably.
• Real-time Monitoring: Keep track of your deployment logs and live project statuses exactly as they happen.
• Containerized: Fully packaged with Docker for "one-click" local spin-ups and production environments.

📸 Screenshots

Dashboard	Setup Screen

Deployments	Projects Page

Deployment Logs

🏗️ Architecture Stack

• Frontend: Flutter Web (served via Nginx)
• Backend: Node.js (Express.js)
• Database: MongoDB 6
• Event Streaming: Apache Kafka
• Orchestration: Docker & Docker Compose

💻 Running Locally

To run this project locally on your machine, you must have Docker Desktop installed and running.

1. Clone the repository

git clone https://github.com/MohitSingh2002/deploystack.git
cd deploystack

2. Configure Environment Variables

If testing strictly locally, defaults will work, but you can override configurations using .env files.

Root Configuration (Database): Create a .env file in the root directory to specify your secure MongoDB password for Docker Compose (if omitted, it defaults to local_dev_password_123 for local testing).

# .env
MONGO_DB_PASSWORD=your_secure_password_here

Frontend Configuration: Create a .env file inside the frontend/ directory to point to your backend API host (defaults to http://localhost:5001).

# frontend/.env
API_HOST=http://localhost:5001

Backend Configuration: Create a .env file inside the backend/ directory.

# backend/.env
FRONTEND_URL=http://localhost:8080
MONGO_URI=mongodb://admin:local_dev_password_123@mongo:27017/deploystack?authSource=admin

3. Spin up the Containers

Run Docker Compose to build and start the entire stack:

docker compose up -d --build

Note: The initial build may take some time depending on your internet speed, as it needs to download the Flutter SDK, build the web app, and pull the images for Kafka and MongoDB.

4. Access the Application

• Frontend Dashboard: http://localhost:8080
• Backend API: http://localhost:5001

(To stop the stack, run docker compose down)

🚢 Deploying to a VPS

DeployStack includes a powerful, automated install.sh script to set up everything on a fresh Ubuntu VPS in practically zero steps.

1. SSH into your VPS.
2. Run the installation script as root:

curl -fsSL https://raw.githubusercontent.com/MohitSingh2002/deploystack/main/install.sh | sudo bash

What the script does automatically:

• Installs Docker, Docker Compose, and Node.js
• Retrieves your server's Public IPv4 address seamlessly.
• Generates a highly secure, cryptographically random password for your MongoDB instance so no credentials are ever hardcoded in your repository.
• Dynamically generates .env files for the frontend, backend, and Docker compose stack using your Public IP and new secure password.
• Starts the docker-compose stack natively.
• Assures the required UFW firewall ports (8080 & 5001) are open.

(Security Note: Sensitive infrastructure ports including MongoDB and Kafka are securely bound to 127.0.0.1 and password-protected, keeping your production data completely inaccessible from the public internet and automated botnet attacks).

🤝 Contributing

Contributions are always welcome! Feel free to open an issue or submit a Pull Request.