Admin Dashboard, Webdocs, LICENSE, webhook, and ID's update.
This commit is contained in:
13
README.md
13
README.md
@@ -7,6 +7,9 @@ A minimal, self-hosted Platform as a Service (PaaS) for building and deploying a
|
||||
- **Docker-based**: Each deployment runs in an isolated Docker container.
|
||||
- **Real-time Logs**: View build and runtime logs streamed directly to the dashboard.
|
||||
- **Port Management**: Automatically assigns and manages ports for your applications.
|
||||
- **Deployment History**: Track every build with detailed commit info and status.
|
||||
- **Environment Variables**: Securely manage runtime configuration.
|
||||
- **Manual Redeploy**: Trigger rebuilds with a single click.
|
||||
- **Zero Configuration**: Just provide a repo URL, and Clickploy handles the rest.
|
||||
|
||||
## Tech Stack
|
||||
@@ -15,7 +18,17 @@ A minimal, self-hosted Platform as a Service (PaaS) for building and deploying a
|
||||
- **Build Engine**: Nixpacks
|
||||
- **Database**: SQLite (Embedded)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
- Docker & Docker Compose
|
||||
- Go 1.21+ (for development)
|
||||
- Node.js 20+ (for development)
|
||||
|
||||
### Running Locally
|
||||
1. Clone the repository.
|
||||
2. Run `docker-compose up --build`.
|
||||
3. Access the dashboard at `http://localhost:5173`.
|
||||
|
||||
## Architecture
|
||||
Clickploy acts as a control plane for your deployments. It clones your repository, builds a Docker image using Nixpacks, and spins up a container. It manages a persistent database of projects and deployments, ensuring state is maintained across restarts.
|
||||
|
||||
Reference in New Issue
Block a user