beubo

package module

v0.0.0-...-7b0100a Latest Latest Go to latest Published: Jan 25, 2021 License: MIT Imports: 37 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/uberswe/beubo

Links

Open Source Insights

README ¶

Beubo

Beubo is in Alpha and not recommended for production use, expect breaking changes and bugs

I created Beubo to get better at Go. To learn more and to make it easier to get going with new projects. None of the platforms or libraries in the Go ecosystem felt right for me. That's why I set out to make my own CMS/Library, Beubo.

Beubo is a CMS that aims to be easy to use and written in Go. I wanted it to be as easy to use as Wordpress but with much better performance and with support for multiple websites right from the start. I try to keep the capabilities of Beubo as small as possible. I hope I can make Beubo easy to build on using plugins so that it can be used for anything and everything.

Here are a few of the features I want to support:

Site management, routing based on domain
Page creation, editing, deletion
Themes
Plugins
User management with roles and permissions

That's pretty much it.

Simply run go run cmd/beubo/main.go to get started.

Database

Beubo uses GORM to handle database operations. Currently I am supporting sqlite3 and mysql but other drivers may work but have not been tested.

Installation

When running Beubo for the first time an installation page will open at the specified port. The page asks for various details needed to configure your site including database details. You will need to create a database on a MariaDB server and provide details so that Beubo can connect to it. You can also use sqlite3 but I only recommend it for local development.

Once the installation is complete it will no longer be available, delete the .env file to redo the installation process. To start with a fresh database simply truncate your current database and it will auto migrate and seed a fresh database.

CLI options

-port=8080      Allows you to specify which port Beubo should listen on

Templating

Beubo uses the go html templates to build pages. These templates use functions to render sections of content which plugins can hook into when a request is made.

Plugins

Beubo supports go plugins. Simply place your .so under /plugins and Beubo will try to load this plugin as it starts. A plugin will need to expose a Register method in order to run. Please see the example plugin to learn more.

Documentation ¶

Index ¶

Variables
func Init()
func Install(w http.ResponseWriter, r *http.Request)
func Run()

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// DB is used to perform database queries globally. In the future this should probably
	// be changed so that database.go declares methods that can be used to perform types of
	// queries
	DB *gorm.DB
)

Functions ¶

func Init ¶

func Init()

Init is called to start Beubo, this calls various other functions that initialises some basic settings

func Install ¶

func Install(w http.ResponseWriter, r *http.Request)

Install handles installation requests and presents the install page

func Run ¶

func Run()

Run runs the main application

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
beubo
pkg
middleware
plugin
routes
structs
structs/page
structs/page/component
structs/page/menu
template
utility

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