{"id":46718260,"url":"https://github.com/coldsmirk/vef-framework-go","last_synced_at":"2026-06-15T19:00:36.960Z","repository":{"id":343896558,"uuid":"1176705246","full_name":"coldsmirk/vef-framework-go","owner":"coldsmirk","description":"A comprehensive, enterprise-grade web framework for Go that accelerates the development of scalable, maintainable applications","archived":false,"fork":false,"pushed_at":"2026-05-30T13:56:46.000Z","size":5151,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-30T14:04:55.001Z","etag":null,"topics":["approval-workflow","cqrs","crud","dependency-injection","enterprise","fiber","go","golang","orm","rest-api","web-framework"],"latest_commit_sha":null,"homepage":"https://coldsmirk.github.io/vef-framework-go-docs","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coldsmirk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security/api_errors.go","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-09T09:41:43.000Z","updated_at":"2026-05-30T13:56:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/coldsmirk/vef-framework-go","commit_stats":null,"previous_names":["coldsmirk/vef-framework-go"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/coldsmirk/vef-framework-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldsmirk%2Fvef-framework-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldsmirk%2Fvef-framework-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldsmirk%2Fvef-framework-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldsmirk%2Fvef-framework-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coldsmirk","download_url":"https://codeload.github.com/coldsmirk/vef-framework-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldsmirk%2Fvef-framework-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34376125,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["approval-workflow","cqrs","crud","dependency-injection","enterprise","fiber","go","golang","orm","rest-api","web-framework"],"created_at":"2026-03-09T11:10:40.957Z","updated_at":"2026-06-15T19:00:36.955Z","avatar_url":"https://github.com/coldsmirk.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eVEF Framework Go\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./mascot.png\" alt=\"VEF Framework Mascot\" width=\"180\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  An opinionated Go framework for enterprise applications, built with Fiber, Uber FX, and Bun.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Unified API resources, generic CRUD, authentication, RBAC, validation, caching, events, storage, MCP, and more.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"./README.md\"\u003eEnglish\u003c/a\u003e |\n  \u003ca href=\"./README.zh-CN.md\"\u003e简体中文\u003c/a\u003e |\n  \u003ca href=\"#quick-start\"\u003eQuick Start\u003c/a\u003e |\n  \u003ca href=\"https://coldsmirk.github.io/vef-framework-go-docs\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://pkg.go.dev/github.com/coldsmirk/vef-framework-go\"\u003eAPI Reference\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/coldsmirk/vef-framework-go/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/coldsmirk/vef-framework-go?style=flat-square\u0026label=release\" alt=\"GitHub Release\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/coldsmirk/vef-framework-go/actions/workflows/test.yml\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/coldsmirk/vef-framework-go/test.yml?branch=main\u0026label=tests\u0026style=flat-square\u0026logo=githubactions\" alt=\"Build Status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/coldsmirk/vef-framework-go\"\u003e\u003cimg src=\"https://img.shields.io/codecov/c/github/coldsmirk/vef-framework-go?style=flat-square\u0026logo=codecov\u0026label=codecov\" alt=\"Coverage\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pkg.go.dev/github.com/coldsmirk/vef-framework-go\"\u003e\u003cimg src=\"https://img.shields.io/badge/go-reference-00ACD7?style=flat-square\u0026logo=go\u0026logoColor=white\" alt=\"Go Reference\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://goreportcard.com/report/github.com/coldsmirk/vef-framework-go\"\u003e\u003cimg src=\"https://img.shields.io/badge/go%20report-A%2B-75C46B?style=flat-square\" alt=\"Go Report Card\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://deepwiki.com/coldsmirk/vef-framework-go\"\u003e\u003cimg src=\"https://img.shields.io/badge/Ask-DeepWiki-1f6feb?style=flat-square\" alt=\"Ask DeepWiki\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/coldsmirk/vef-framework-go/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/coldsmirk/vef-framework-go?style=flat-square\u0026label=license\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nVEF Framework Go combines dependency injection, HTTP routing, and data access into a cohesive application framework, with built-in support for API resources, authentication, RBAC, validation, caching, events, storage, MCP, and more.\n\n\u003e This README is intentionally brief. Detailed tutorials and reference material are available on the [documentation site](https://coldsmirk.github.io/vef-framework-go-docs).\n\n\u003e Development status: the project is still pre-1.0. Expect breaking changes while conventions and APIs continue to evolve.\n\n## Why VEF\n\n- One resource model for both RPC and REST APIs\n- Generic CRUD primitives that reduce repetitive backend code\n- Modular composition with Uber FX for clean wiring and extension\n- Built-in auth, RBAC, rate limiting, audit, caching, events, storage, MCP, and other infrastructure you would otherwise assemble yourself\n\n## Quick Start\n\nRequirements:\n- Go 1.26.0 or newer\n- `CGO_ENABLED=1` and a C toolchain — the built-in expression engine links the cgo-based `zen-go` library, so the framework cannot be built with `CGO_ENABLED=0`\n- A supported database such as PostgreSQL, MySQL, or SQLite\n\nInstall:\n```bash\ngo get github.com/coldsmirk/vef-framework-go\n```\n\nCreate `main.go`:\n\n```go\npackage main\n\nimport \"github.com/coldsmirk/vef-framework-go\"\n\nfunc main() {\n\tvef.Run()\n}\n```\n\nCreate `configs/application.toml`:\n\n```toml\n[vef.app]\nname = \"my-app\"\nport = 8080\n\n[vef.data_sources.primary]\ntype = \"sqlite\"\npath = \"./my-app.db\"\n\n# Additional named sources are optional; each one is reachable through\n# datasource.Registry.Get(\"\u003cname\u003e\"). Example:\n# [vef.data_sources.analytics]\n# type = \"postgres\"\n# host = \"analytics.example.com\"\n# database = \"warehouse\"\n```\n\nThis is the smallest runnable configuration. Sections such as `vef.monitor`, `vef.mcp`, and `vef.approval` are optional.\n\nRun:\n\n```bash\ngo run main.go\n```\n\nVEF loads `application.toml` from `./configs`, `.`, `../configs`, or the path pointed to by `VEF_CONFIG_PATH`.\n\n## Core Concepts\n\n- `vef.Run(...)` starts the framework and wires the default module chain: config, data sources (the registry and primary database connection), middleware, API, security, event, CQRS, cron, redis, mold, storage, sequence, schema, monitor, MCP, and app.\n- API endpoints are defined as resources with `api.NewRPCResource(...)` or `api.NewRESTResource(...)`.\n- Business modules are composed with FX options, for example `vef.ProvideAPIResource(...)`, `vef.ProvideMiddleware(...)`, and `vef.ProvideMCPTools(...)`.\n- CRUD-heavy modules can build on the generic helpers in `crud/` instead of writing repetitive handlers from scratch.\n\nTypical application layout:\n\n```text\nmy-app/\n├── cmd/\n├── configs/\n└── internal/\n    ├── auth/\n    ├── sys/\n    ├── \u003cdomain\u003e/\n    └── web/\n```\n\n## Documentation\n\n- Documentation site: \u003chttps://coldsmirk.github.io/vef-framework-go-docs\u003e\n- API reference: \u003chttps://pkg.go.dev/github.com/coldsmirk/vef-framework-go\u003e\n- Repository knowledge map: \u003chttps://deepwiki.com/coldsmirk/vef-framework-go\u003e\n- Testing conventions: [TESTING.md](./TESTING.md)\n\nIf you need step-by-step guides, architectural deep dives, or feature-specific reference, prefer the [documentation site](https://coldsmirk.github.io/vef-framework-go-docs) rather than expanding this README.\n\n## Development\n\nCommon verification commands:\n\n```bash\ngo test ./...\ngo test -race ./...\ngolangci-lint run\ngo run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -test ./...\n```\n\n## License\n\nLicensed under the [Apache License 2.0](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldsmirk%2Fvef-framework-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoldsmirk%2Fvef-framework-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldsmirk%2Fvef-framework-go/lists"}