README
¶
go build -o kudzu cmd/kudzu/main.go
./kudzu build
./kudzu run
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
management
|
|
|
editor
Package editor enables users to create edit views from their content structs so that admins can manage content
|
Package editor enables users to create edit views from their content structs so that admins can manage content |
|
format
Package format provides interfaces to format content into various kinds of data
|
Package format provides interfaces to format content into various kinds of data |
|
manager
Package manager contains the admin UI to the CMS which wraps all content editor interfaces to manage the create/edit/delete capabilities of kudzu content.
|
Package manager contains the admin UI to the CMS which wraps all content editor interfaces to manage the create/edit/delete capabilities of kudzu content. |
|
Package system contains a collection of packages that make up the internal kudzu system, which handles addons, administration, the Admin server, the API server, analytics, databases, search, TLS, and various internal types.
|
Package system contains a collection of packages that make up the internal kudzu system, which handles addons, administration, the Admin server, the API server, analytics, databases, search, TLS, and various internal types. |
|
addon
Package addon provides an API for kudzu addons to interface with the system
|
Package addon provides an API for kudzu addons to interface with the system |
|
admin
Package admin desrcibes the admin view containing references to various managers and editors
|
Package admin desrcibes the admin view containing references to various managers and editors |
|
admin/config
Package config provides a content type to manage the kudzu system's configuration settings for things such as its name, domain, HTTP(s) port, email, server defaults and backups.
|
Package config provides a content type to manage the kudzu system's configuration settings for things such as its name, domain, HTTP(s) port, email, server defaults and backups. |
|
admin/upload
Package upload provides a re-usable file upload and storage utility for kudzu systems to handle multipart form data.
|
Package upload provides a re-usable file upload and storage utility for kudzu systems to handle multipart form data. |
|
admin/user
Package user contains the basic admin user creation and authentication code, specific to kudzu systems.
|
Package user contains the basic admin user creation and authentication code, specific to kudzu systems. |
|
api
Package api sets the various API handlers which provide an HTTP interface to kudzu content, and include the types and interfaces to enable client-side interactivity with the system.
|
Package api sets the various API handlers which provide an HTTP interface to kudzu content, and include the types and interfaces to enable client-side interactivity with the system. |
|
api/analytics
Package analytics provides the methods to run an analytics reporting system for API requests which may be useful to users for measuring access and possibly identifying bad actors abusing requests.
|
Package analytics provides the methods to run an analytics reporting system for API requests which may be useful to users for measuring access and possibly identifying bad actors abusing requests. |
|
db
Package db contains all interfaces to the databases used by kudzu, including exported functions to easily manage addons, users, indices, search, content, and configuration.
|
Package db contains all interfaces to the databases used by kudzu, including exported functions to easily manage addons, users, indices, search, content, and configuration. |
|
item
Package item provides the default functionality to kudzu's content/data types, how they interact with the API, and how to override or enhance their abilities using various interfaces.
|
Package item provides the default functionality to kudzu's content/data types, how they interact with the API, and how to override or enhance their abilities using various interfaces. |
|
search
Package search is a wrapper around the blevesearch/bleve search indexing and query package, and provides interfaces to extend kudzu items with rich, full-text search capability.
|
Package search is a wrapper around the blevesearch/bleve search indexing and query package, and provides interfaces to extend kudzu items with rich, full-text search capability. |
|
tls
Package tls provides the functionality to kudzu systems to encrypt HTTP traffic through the ability to generate self-signed certificates for local development and fetch/update production certificates from Let's Encrypt.
|
Package tls provides the functionality to kudzu systems to encrypt HTTP traffic through the ability to generate self-signed certificates for local development and fetch/update production certificates from Let's Encrypt. |
Click to show internal directories.
Click to hide internal directories.