5 Commits

Author SHA1 Message Date
Vectry
993bb08dff docs: add subscription features, pricing tiers, API keys, and getting started sections to README
All checks were successful
Deploy CodeBoard / deploy (push) Successful in 32s
2026-02-11 00:34:45 +00:00
Vectry
9221c9eacd fix: skip Docker install, use pre-installed CLI from runner image
All checks were successful
Deploy CodeBoard / deploy (push) Successful in 2m29s
2026-02-10 23:38:46 +00:00
Vectry
2329118ff6 fix: use TCP docker host, fix heredoc whitespace, fix health checks in deploy workflow 2026-02-10 23:31:18 +00:00
Vectry
85ee006ad0 Fix deploy workflow: use ubuntu-latest with Docker CLI install 2026-02-10 23:22:08 +00:00
Vectry
1187ca6af9 Add Gitea Actions deploy-on-tag workflow 2026-02-10 23:18:54 +00:00
2 changed files with 116 additions and 0 deletions

View File

@@ -0,0 +1,67 @@
name: Deploy CodeBoard
on:
push:
tags:
- "v*"
workflow_dispatch:
env:
COMPOSE_PROJECT_NAME: codeboard
DOCKER_HOST: tcp://192.168.1.133:2375
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Verify Docker access
run: |
docker version
docker compose version
- name: Write environment file
run: |
cat > .env <<'ENVEOF'
OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }}
LLM_BASE_URL=${{ secrets.LLM_BASE_URL }}
LLM_MODEL=${{ secrets.LLM_MODEL }}
AUTH_SECRET=${{ secrets.AUTH_SECRET }}
STRIPE_SECRET_KEY=${{ secrets.STRIPE_SECRET_KEY }}
STRIPE_WEBHOOK_SECRET=${{ secrets.STRIPE_WEBHOOK_SECRET }}
STRIPE_STARTER_PRICE_ID=${{ secrets.STRIPE_STARTER_PRICE_ID }}
STRIPE_PRO_PRICE_ID=${{ secrets.STRIPE_PRO_PRICE_ID }}
EMAIL_PASSWORD=${{ secrets.EMAIL_PASSWORD }}
ENVEOF
sed -i 's/^[[:space:]]*//' .env
- name: Build and deploy
run: |
echo "Deploying CodeBoard ${{ gitea.ref_name }}..."
docker compose build web worker migrate
docker compose up -d --no-deps --remove-orphans web worker migrate redis postgres
echo "Waiting for migration and startup..."
sleep 25
- name: Health check
run: |
for i in 1 2 3 4 5; do
STATUS=$(docker inspect --format='{{.State.Running}}' codeboard-web-1 2>/dev/null || true)
if [ "$STATUS" = "true" ]; then
echo "Container running (attempt $i)"
exit 0
fi
echo "Attempt $i/5 — retrying in 10s..."
sleep 10
done
echo "Health check failed after 5 attempts"
docker compose logs web --tail 50
exit 1
- name: Cleanup
if: always()
run: docker image prune -f

View File

@@ -2,6 +2,55 @@
Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes. Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes.
**Live at [codeboard.vectry.tech](https://codeboard.vectry.tech)**
## Getting Started
1. **Register** at [codeboard.vectry.tech/register](https://codeboard.vectry.tech/register) with your email and password.
2. **Log in** to access the dashboard, generation history, and settings.
3. **Paste a GitHub URL** and generate interactive onboarding documentation.
Registration is required for full access. Unauthenticated visitors can view the landing page, but generating documentation, viewing your dashboard, and browsing generation history all require a logged-in account.
## Plans and Pricing
CodeBoard offers three billing tiers. One generation equals one documentation build from a repository URL.
| Plan | Price | Generations | Highlights |
|------|-------|-------------|------------|
| **Free** | $0 | 15 per day | Public repos, architecture diagrams, interactive docs |
| **Starter** | $5 / month | 1,000 per month | Generation history, API key access, priority support |
| **Pro** | $20 / month | 100,000 per month | Full history, multiple API keys, dedicated support, custom integrations |
Manage your subscription in **Settings > Billing** from the dashboard.
## API Keys (Programmatic Access)
Paid plans (Starter and Pro) include API key access for programmatic diagram and documentation generation.
1. Navigate to **Settings > API Keys** in the dashboard.
2. Create a new key and copy it immediately -- it is shown only once.
3. Include the key in your requests:
```bash
curl -X POST https://codeboard.vectry.tech/api/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"repoUrl": "https://github.com/owner/repo"}'
```
Each successful API call counts as one generation against your plan's quota.
## Generation History
All generated documentation is saved to your account. From the dashboard you can:
- Browse past generations per repository.
- Compare documentation versions side-by-side to track codebase changes over time.
- Re-open any previous generation by its unique link.
History is per-user -- each account maintains its own generation records.
## Architecture ## Architecture
``` ```