https://github.com/ashmit-kumar/auto-ship
Automated deployment platform that builds, hosts, and serves GitHub projects with instant live URLs.
https://github.com/ashmit-kumar/auto-ship
docker docker-compose golang hosting hosting-aws nginx nginx-configuration nginx-proxy
Last synced: about 2 months ago
JSON representation
Automated deployment platform that builds, hosts, and serves GitHub projects with instant live URLs.
- Host: GitHub
- URL: https://github.com/ashmit-kumar/auto-ship
- Owner: Ashmit-Kumar
- License: mit
- Created: 2025-04-25T01:22:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-21T17:21:09.000Z (3 months ago)
- Last Synced: 2026-03-22T07:11:29.389Z (3 months ago)
- Topics: docker, docker-compose, golang, hosting, hosting-aws, nginx, nginx-configuration, nginx-proxy
- Language: TypeScript
- Homepage:
- Size: 4.08 MB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🚀 Auto-Ship
This project aims to build a hosting platform similar to Vercel or Netlify. It allows users to deploy their GitHub repositories and host them with a unique live link.
## 🧠 **Basic Workflow**
### 1. User Input
- Users submit their GitHub repository URL through a form.
- The system validates the URL to ensure it points to a valid GitHub repository.
### 2. Clone Repository
- The backend clones the repository using Go.
- Cloned repositories are stored in temporary directories with unique identifiers.
### 3. Build & Host
- The system detects the project type (e.g., HTML, Node.js, React).
- It installs dependencies, builds the project if required, and serves it using a static file server or runtime environment.
### 4. Assign URL
- Each project is assigned a unique URL (e.g., `username.yourdomain.com` or `yourdomain.com/project/12345`).
- Reverse proxy settings are updated to map the URL to the hosted project.
### 5. Show Live Link
- Users receive a live link to their hosted project, which they can copy or share.
## 🔧 **Tech Stack**
### Frontend
- **Framework**: Next.js
- **Styling**: Tailwind CSS
- **Features**: URL submission, progress tracking, live link display, and user authentication.
### Backend
- **Language**: Go
- **Framework**: Gin or Echo
- **Features**: Repository cloning, building, and serving.
### Deployment
- **Containerization**: Docker
- **Reverse Proxy**: NGINX
- **Database**: PostgreSQL for URL management.
## 🛡️ **Security and Maintenance**
- **Input Sanitization**: Prevent injection attacks.
- **Rate Limiting**: Avoid abuse and monitor GitHub API usage.
- **Cleanup**: Automatically remove old repositories and builds.
- **Build Logs**: Provide real-time logs for transparency and debugging.
## 🧪 **MVP Goals**
1. Allow users to input a GitHub repository URL.
2. Clone the repository and build the project.
3. Serve the project and provide a live link.
---
This README outlines the project's goals and tasks. Contributions and feedback are welcome.