README.md

82 lines
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
# Congo

Single-binary Go framework. Routing, database, templates, deployment — all included. Source code vendored into your project.

## Quick Start

```bash
congo init myapp
cd myapp
congo dev
```

Open `localhost:5000`. You have a running web app.

## Deploy

```bash
congo launch
```

Builds a Docker image, ships it to your server, starts it with health checks and rollback.

## What's Inside

When you run `congo init`, the full framework is copied into your project as regular Go files:

```
myapp/
  internal/          Framework source (yours to modify)
    application/     HTTP server, routing, templates, middleware
    database/        ORM with auto-migration, SQLite/LibSQL
    frontend/        React islands, esbuild, HMR
    assistant/       AI chat, streaming, tool calling
    platform/        Cloud servers, Docker, SSH, deployment
  web/
    controllers/     Route handlers
    models/          Data models
    views/           HTML templates (HTMX + DaisyUI)
    main.go          Entry point
```

No hidden magic. Open any file and read it.

## Commands

| Command | What it does |
|---------|-------------|
| `congo init <name>` | Create a new project |
| `congo dev` | Development server with hot reload |
| `congo build` | Compile production binary |
| `congo launch` | Deploy to your server |
| `congo claude` | AI-assisted development with full framework context |
| `congo new <name>` | Add an app to existing project |
| `congo source` | Extract buildable copy of the framework |
| `congo connect` | SSH into deployed server |
| `congo status` | Check deployment health |
| `congo logs` | Stream service logs |
| `congo destroy` | Tear down infrastructure |

## AI-Assisted Development

```bash
congo claude
```

Launches Claude Code with a complete framework reference. The AI knows the controller pattern, the model API, the template conventions, and the HTMX patterns.

## Requirements

- [Go 1.25+](https://go.dev/dl/)

## Links

- [Tutorial](https://congo.gg/tutorial) — Make a website in 15 minutes, no experience needed
- [Guide](https://congo.gg/guide) — Full walkthrough with controllers, models, views, deployment
- [Philosophy](https://congo.gg/philosophy) — Why these choices
- [Source](https://congo.gg/source) — Browse the framework source
- [Download](https://congo.gg/download) — Prebuilt binaries

## License

MIT