devspace-kit
v1.3.0
Published
Interactive CLI for scaffolding applications, Docker and Kubernetes configurations
Readme
Devspace empowers developers to instantly spin up complete application structures—handling frontend and backend framework setups, generating optimized Docker configurations, and building cloud-ready Kubernetes manifests with a single command-line interface.
📦 Fast Installation
Instead of cloning the source code and compiling dependencies manually, you can download the standalone executable immediately:
- Head over to the Latest Releases section on GitHub.
- Download
devspace.exe. - Drop it into your target workspace directory.
Step-by-Step Guide: Creating Your First Service
Follow this complete walkthrough to initialize your workspace, containerize your app, and deploy it to a cluster.
1. Initialize Devspace
Run the following command:
.\devspace.exe createIf this is your first time using Devspace, GitHub authentication is required.
Set your GitHub Personal Access Token:
set GITHUB_TOKEN=YOUR_GITHUB_TOKENAfter setting the token, run the initialization command again:
.\devspace.exe create2. Configure Your Project
Devspace will launch an interactive setup wizard.
You'll be prompted to provide the following information:
Project Directory
Specify where the project should be generated.
C:\Users\YourName\DesktopMicroservice Name
Provide a name for your service.
my-serviceBackend Framework
Choose one of the available backend frameworks.
Go (Golang)
Python (Django)
Node.js (Express)
Rust (Actix-web)Frontend Framework
Choose your preferred frontend framework.
React (Vite)
Next.js
Vue.js
Svelte
None (Backend API Only)Kubernetes Replicas
Enter the number of replicas to deploy.
3CPU Resource Profile
Select the CPU request profile.
100m (Lightweight)
250m (Medium)
500m (High Performance)Memory Resource Profile
Select the memory request profile.
128Mi
256Mi
512Mi
1024Mi (1Gi)Kubernetes Service Type
Choose how your application will be exposed.
ClusterIP
NodePort
LoadBalancerAfter confirming the configuration, Devspace automatically generates your complete project.
📂 Generated Project Structure
Your workspace will contain a production-ready project similar to the following:
my-service/
├── backend/
├── frontend/
├── k8s/
├──myservice-backend-deployment.yaml
├──myservice-backend-service.yaml
├──myservice-frontend-deployment.yaml
└──myservice-frontend-deployment.yaml
├── Dockerfile
├── .dockerignorefileNote: The generated files may vary depending on the frameworks you selected.
Develop Your Application
After project generation, implement your business logic by modifying the generated files.
Typical files you'll edit include:
- Backend source code
- Frontend application
- Dockerfile
- Kubernetes manifests
- Environment variables
🐳 Build Docker Images
Devspace uses a multi-stage Dockerfile, allowing frontend and backend images to be built independently.
Build the frontend image:
docker build --target frontend -t my-frontend .Build the backend image:
docker build --target backend -t my-backend .☸ Deploy to Kubernetes
Deploy the generated Kubernetes manifests.
kubectl apply -f kubernetes/Verify that the deployment was successful.
Check Pods:
kubectl get podsCheck Services:
kubectl get svcCheck Deployments:
kubectl get deploymentsIf all resources are running successfully, your application is now deployed on Kubernetes.
Complete Workflow
Download Devspace
│
▼
Run:
.\devspace.exe create
│
▼
Configure Project
│
▼
Project Generated
│
▼
Develop Your Application
│
▼
Build Docker Images
│
▼
Deploy to Kubernetes
│
▼
Application Running 🚀