# ccbCode

**Repository Path**: chenyanxiCode/ccb-code

## Basic Information

- **Project Name**: ccbCode
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-15
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# V-Club Crawler

V-Club Crawler is a Go-based crawler management system for `v-club.com`, including:

- authenticated crawling
- attachment/cloud-task workflows
- PDF conversion pipeline
- admin API + Vue frontend
- observability (Prometheus, Grafana, OpenTelemetry)

## Tech Stack

- Backend: Go 1.24+, Chi, pgx, Redis, asynq
- Crawler: colly + chromedp
- Frontend: Vue 3 + TypeScript + Element Plus
- Storage: PostgreSQL + filesystem
- Observability: Prometheus + Grafana + OpenTelemetry

## Quick Start (Docker Compose)

1. Prepare config:

```bash
cp configs/config.yaml configs/config.local.yaml
# edit DB/Redis/passwords as needed
```

2. Start services:

```bash
docker compose up -d --build
```

3. Verify:

```bash
curl http://localhost:8080/health
curl http://localhost:8080/metrics
curl http://localhost:9091/metrics
```

4. Access dashboards:

- API: `http://localhost:8080`
- Frontend dev (if running Vite separately): `http://localhost:5173`
- Grafana: `http://localhost:3000` (default `admin/admin123`)
- Prometheus: `http://localhost:9090`

## Local Development

```bash
# backend
make build
make test
make run-api
make run-worker

# frontend
cd web
npm install
npm run dev
```

Note:

- `make migrate-up` / `make migrate-down` are currently placeholders.
- Apply SQL files in `migrations/` manually or via your migration tool.

## Default Auth Accounts

From current implementation (`internal/web/auth.go`):

- admin: `admin / admin123`
- viewer: `viewer / viewer123`

Change these for non-local environments.

## Project Layout

```text
cmd/                  # service entrypoints
internal/             # domain modules
migrations/           # SQL schema and tuning migrations
configs/              # runtime and observability config
docs/                 # design, deployment, ops, API docs
web/                  # Vue 3 admin frontend
```

## Documentation

- Design: `docs/DESIGN.md`
- Deployment: `docs/DEPLOYMENT.md`
- Operations: `docs/OPERATIONS.md`
- API Reference: `docs/API.md`

## Current Status

Core backend/frontend/observability modules are implemented for MVP and integration testing.
Some production-hardening items remain (for example migration automation and secret rotation workflows).