README.md

kodesphere

kodesphere is a cloud-based deployment platform that allows users to deploy their applications using subdomains in the format:

<subdomain>.<github-username>.vitians.in  

This is achieved through Docker, Kubernetes, and Ingress.

🌐 Live URLs

• Main App: ks.upayan.dev
• API: api.ks.upayan.dev
• K8s API: api.vitians.in

📦 Docker Images

• Main kodesphere Image: ghcr.io/upayanmazumder/kodesphere
• Kubernetes Deployment Image: ghcr.io/upayanmazumder/kodesphere/k8s

🖥️ Kubernetes Deployment

The Kubernetes server for kodesphere is hosted at:

api.vitians.in  

It manages and orchestrates deployments for users.

🎨 UI/UX Design

Check out the Figma design for kodesphere: Figma

🚀 Features

• Deploy applications using a structured subdomain system.
• Use Docker images with port mapping and environment variables.
• Kubernetes-based deployment and orchestration.
• Secure and scalable hosting.

🏗️ How It Works

Check out the presentation and more in assets!

1. Choose a Subdomain:
   Users select a subdomain under vitians.in (e.g., myapp.user123.vitians.in).

2. Provide a Docker Image:
   The platform supports Docker images, allowing users to specify the image, ports, and environment variables.

3. Deployment via API:
   The API at api.ks.upayan.dev handles the deployment process.

4. Access the Application:
   Once deployed, the application becomes accessible via the assigned subdomain.

🛠️ Setup and Usage

Deploying a Site

To deploy an application, send a request to the kodesphere API with the necessary details:

{
  "image": "your-docker-image:latest",
  "domains": [
    {
      "url": "example.com",
      "ports": [80, 443]
    }
  ],
  "name": "my-app",
  "env": {
    "ENV_VAR1": "value1",
    "ENV_VAR2": "value2"
  },
  "namespace": "custom-namespace"
}

Managing Deployments

Users can update or remove their deployments through API endpoints.

🏆 Team

kodesphere is built by The Orchaestrators.

• Upayan Mazumder - LinkedIn
• Atharva Sharma - LinkedIn
• Advik Gupta - LinkedIn
• Chitrita Gahlot - LinkedIn
• Diya Bajoria - LinkedIn