https://github.com/zopdev/zop-api
https://github.com/zopdev/zop-api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/zopdev/zop-api
- Owner: zopdev
- License: apache-2.0
- Created: 2024-12-05T10:17:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-08T09:53:18.000Z (5 months ago)
- Last Synced: 2025-10-08T11:34:04.819Z (5 months ago)
- Language: Go
- Size: 151 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZopDev
Zop is a comprehensive tool for managing cloud infrastructure. It consists of three main components:
1. **zop-api**: Backend API service.
2. **zop-ui**: User interface for managing and monitoring cloud resources.
3. **zop-cli**: Command-line interface for developers and admins.
---
## Installation
### Prerequisites
- Docker installed on your system.
---
### Running Locally
#### zop-api
Run the following command to pull and start the Docker image for the zop-api:
```bash
docker run -d -p 8000:8000 --name zop-api zopdev/zop-api:v0.0.3
```
#### zop-ui
Run the following command to pull and start the Docker image for the zop-ui:
```bash
docker run -d -p 3000:3000 -e NEXT_PUBLIC_API_BASE_URL='http://localhost:8000' --name zop-ui zopdev/zop-ui:v0.0.3
```
> **Note:** The environment variable `NEXT_PUBLIC_API_BASE_URL` is used by zop-ui to connect to the zop-api. Ensure that the value matches the API's running base URL.
#### zop-cli
Run the following command install zop-cli:
```bash
go install zop.dev/clizop@latest
```
> **Note:** Set the environment variable `ZOP_API_URL`, used by zop-cli to connect to the zop-api. Ensure that the value matches the API's running base URL.
### zop-api
swagger endpoint - `/.well-known/swagger`