congo

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 5, 2026 License: MIT Imports: 1 Imported by: 0

README

Congo

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

Quick Start

congo init myapp
cd myapp
congo dev

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

Deploy

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

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

  • Tutorial — Make a website in 15 minutes, no experience needed
  • Guide — Full walkthrough with controllers, models, views, deployment
  • Philosophy — Why these choices
  • Source — Browse the framework source
  • Download — Prebuilt binaries

License

MIT

Documentation

Overview

Package congo provides embedded filesystems for the Congo framework CLI.

Congo is a single-binary Go framework that scaffolds web applications with vendored source code. This root package exports the embedded scaffold templates, framework source, and Claude Code context used by the CLI (cmd/) and promotional website (web/).

Index

Constants

This section is empty.

Variables

View Source
var ClaudeContext string

ClaudeContext is the framework documentation injected into CLAUDE.md by the "congo claude" command.

View Source
var ScaffoldFS embed.FS

ScaffoldFS contains project templates (res/scaffold/): go.mod.tmpl, Makefile.tmpl, controller templates, view templates, etc.

View Source
var SourceFS embed.FS

SourceFS contains the entire Congo source tree. Used by the CLI for scaffold extraction (pkg/), the source browser, and viral distribution.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
pkg
assistant
Package assistant provides AI provider abstraction for chat completions.
Package assistant provides AI provider abstraction for chat completions.
assistant/providers/anthropic
Package anthropic provides an Anthropic implementation of assistant.Backend.
Package anthropic provides an Anthropic implementation of assistant.Backend.
assistant/providers/mock
Package mock provides a mock AI provider for testing.
Package mock provides a mock AI provider for testing.
assistant/providers/openai
Package openai provides an OpenAI implementation of assistant.Backend.
Package openai provides an OpenAI implementation of assistant.Backend.
frontend/esbuild
Package esbuild provides a bundler for frontend components using esbuild's Go API.
Package esbuild provides a bundler for frontend components using esbuild's Go API.
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL