gomonolith

package module
Version: v0.0.3 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2021 License: MIT Imports: 49 Imported by: 0

README

uAdmin the Golang Web Framework

Easy to use, blazing fast and secure.

go report card GoDoc gopherbadger-tag-do-not-edit sqlite build status postgres build status

Originally open sourced by IntegrityNet Solutions and Services And then fully rewritten by @sergeyglazyrindev.

For Documentation:

Reach us at:

join gophers.slack.com

Social Media:

Screenshots

Dashboard Menu

Dashboard  

Log

Log  

Login Form

Login Form  

Features

  • AB Testing System
  • API Configuration
  • Approval System
  • Authentication and Permissions
  • Clean and sharp UI
  • Dashboard customization
  • Error Handling
  • Export to Excel
  • Form and List customization
  • Image Cropping
  • IP address and port configuration
  • Full Gorm integration
  • Pretty good security features (SSL, 2-Factor Authentication, Password Reset, Hash Salt Unique for Each user, Database Encryption)
  • Public access to media
  • Self relation of foreign key/many2many
  • Sending an email from your app by establishing an email configuration
  • System settings which can be used system wide to keep application settings
  • Tag support for fields
  • Validation for user input
  • Webcam support on image and file fields

Minimum requirements

Operating System Architectures Notes
FreeBSD 10.3 or later amd64, 386 Debian GNU/kFreeBSD not supported
Linux 2.6.23 or later with glibc amd64, 386, arm, arm64, s390x, ppc64le CentOS/RHEL 5.x not supported. Install from source for other libc.
macOS 10.10 or later amd64 Use the clang or gcc that comes with Xcode for cgo support.
Windows 7, Server 2008 R2 or later amd64, 386 Use MinGW gcc. No need for cygwin or msys.
  • A C compiler is required only if you plan to use cgo.
  • You only need to install the command line tools for Xcode. If you have already installed Xcode 4.3+, you can install it from the Components tab of the Downloads preferences panel.
Hardware
  • RAM - minimum 256MB
  • CPU - minimum 2GHz
Software
  • Go Version 1.16 or later

Installation

$ go get -u github.com/sergeyglazyrindev/go-monolith/...

To test if your installation is fine, run the go-monolith command line:

Get full documentation online: https://go-monolithdocs.sergeyg.me/


## Your First App

[Check it out here]https://go-monolithdocs.sergeyg.me/docs/intro

Documentation

Index

Constants

This section is empty.

Variables

View Source
var CreatedDatabaseForTests bool

Functions

func ClearApp

func ClearApp()

func ClearTestApp

func ClearTestApp()

func RunTests

func RunTests(t *testing.T, currentsuite suite.TestingSuite)

func StoreCurrentApp

func StoreCurrentApp(app *App)

func TestHTTPResponse

func TestHTTPResponse(t *testing.T, app *App, req *http.Request, f func(w *httptest.ResponseRecorder) bool)

Helper function to process a request and test its response

Types

type AddLanguageHandler

type AddLanguageHandler struct {
}

func (AddLanguageHandler) GetHelpText

func (command AddLanguageHandler) GetHelpText() string

func (AddLanguageHandler) Proceed

func (command AddLanguageHandler) Proceed(subaction string, args []string) error

type AddLanguageHandlerOptions

type AddLanguageHandlerOptions struct {
	Code string `short:"c" required:"true" description:"Language you wanna add to the system'"`
}

type AdminCommand

type AdminCommand struct {
}

func (AdminCommand) GetHelpText

func (c AdminCommand) GetHelpText() string

func (AdminCommand) Proceed

func (c AdminCommand) Proceed(subaction string, args []string) error

type AdminStartServerOptions

type AdminStartServerOptions struct {
}

type App

type App struct {
	Config              *core.Config
	Database            *core.Database
	Router              *gin.Engine
	CommandRegistry     *core.CommandRegistry
	BlueprintRegistry   core.IBlueprintRegistry
	DashboardAdminPanel *core.DashboardAdminPanel
	RouterInitialized   bool
}

func NewApp

func NewApp(environment string, dontInitialize ...bool) *App

func NewFullAppForTests

func NewFullAppForTests() *App

func (*App) BaseAPIUrl

func (a *App) BaseAPIUrl() string

func (*App) ExecuteCommand

func (a *App) ExecuteCommand()

func (*App) GetAuthAdapterRegistry

func (a *App) GetAuthAdapterRegistry() *core.AuthProviderRegistry

func (*App) GetBlueprintRegistry

func (a *App) GetBlueprintRegistry() core.IBlueprintRegistry

func (*App) GetCommandRegistry

func (a *App) GetCommandRegistry() *core.CommandRegistry

func (*App) GetConfig

func (a *App) GetConfig() *core.Config

func (*App) GetDashboardAdminPanel

func (a *App) GetDashboardAdminPanel() *core.DashboardAdminPanel

func (*App) GetDatabase

func (a *App) GetDatabase() *core.Database

func (*App) GetRouter

func (a *App) GetRouter() *gin.Engine

func (*App) Initialize

func (a *App) Initialize()

func (*App) InitializeRouter

func (a *App) InitializeRouter()

func (*App) RegisterBaseBlueprints

func (a *App) RegisterBaseBlueprints()

func (*App) RegisterBaseCommands

func (a *App) RegisterBaseCommands()

func (*App) RegisterBlueprint

func (a *App) RegisterBlueprint(blueprint core.IBlueprint)

func (*App) RegisterCommand

func (a *App) RegisterCommand(name string, command core.ICommand)

func (*App) StartAPI

func (a *App) StartAPI()

func (*App) StartAdmin

func (a *App) StartAdmin()

func (*App) TriggerCommandExecution

func (a *App) TriggerCommandExecution(action string, subaction string, params []string)

type BlueprintCommand

type BlueprintCommand struct {
}

func (BlueprintCommand) GetHelpText

func (c BlueprintCommand) GetHelpText() string

func (BlueprintCommand) Proceed

func (c BlueprintCommand) Proceed(subaction string, args []string) error

type ContentTypeCommand

type ContentTypeCommand struct {
}

func (ContentTypeCommand) GetHelpText

func (c ContentTypeCommand) GetHelpText() string

func (ContentTypeCommand) Proceed

func (c ContentTypeCommand) Proceed(subaction string, args []string) error

type CreateBlueprint

type CreateBlueprint struct {
}

func (CreateBlueprint) GetHelpText

func (command CreateBlueprint) GetHelpText() string

func (CreateBlueprint) Proceed

func (command CreateBlueprint) Proceed(subaction string, args []string) error

type CreateBlueprintOptions

type CreateBlueprintOptions struct {
	Message string `short:"m" required:"true" description:"Describe what is this migration for"`
	Name    string `short:"n" required:"true" description:"Blueprint you'd like to create migration for'"`
}

type CreateFakedDataCommand

type CreateFakedDataCommand struct {
}

func (CreateFakedDataCommand) GetHelpText

func (c CreateFakedDataCommand) GetHelpText() string

func (CreateFakedDataCommand) Proceed

func (c CreateFakedDataCommand) Proceed(subaction string, args []string) error

type CreateMigration

type CreateMigration struct {
}

func (CreateMigration) GetHelpText

func (command CreateMigration) GetHelpText() string

func (CreateMigration) Proceed

func (command CreateMigration) Proceed(subaction string, args []string) error

type CreateMigrationOptions

type CreateMigrationOptions struct {
	Message   string `short:"m" description:"Describe what is this migration for"`
	Blueprint string `short:"b" description:"Blueprint you'd like to create migration for"`
	MergeMode bool   `long:"merge" description:"Merge conflicted migrations"`
}

type CreateSuperadmin

type CreateSuperadmin struct {
}

func (CreateSuperadmin) GetHelpText

func (command CreateSuperadmin) GetHelpText() string

func (CreateSuperadmin) Proceed

func (command CreateSuperadmin) Proceed(subaction string, args []string) error

type DbShellCommand

type DbShellCommand struct {
}

func (DbShellCommand) GetHelpText

func (c DbShellCommand) GetHelpText() string

func (DbShellCommand) Proceed

func (c DbShellCommand) Proceed(subaction string, args []string) error

type DetermineConflictsMigration

type DetermineConflictsMigration struct {
}

func (DetermineConflictsMigration) GetHelpText

func (command DetermineConflictsMigration) GetHelpText() string

func (DetermineConflictsMigration) Proceed

func (command DetermineConflictsMigration) Proceed(subaction string, args []string) error

type DownMigration

type DownMigration struct {
}

func (DownMigration) GetHelpText

func (command DownMigration) GetHelpText() string

func (DownMigration) Proceed

func (command DownMigration) Proceed(subaction string, args []string) error

type DownMigrationOptions

type DownMigrationOptions struct {
	ToMigrationID int64 `long:"--to-id" required:"false" default:"0" description:"Migration downgrade your database to"`
}

type GeneralError

type GeneralError struct {
	Error string
}

A GeneralError is an error that is used when something strange happened swagger:response generalError

type LanguageCommand

type LanguageCommand struct {
}

func (LanguageCommand) GetHelpText

func (c LanguageCommand) GetHelpText() string

func (LanguageCommand) Proceed

func (c LanguageCommand) Proceed(subaction string, args []string) error

type MicroserviceExample

type MicroserviceExample struct {
	core.Microservice
}

type MicroserviceExampleCommand

type MicroserviceExampleCommand struct {
}

func (MicroserviceExampleCommand) GetHelpText

func (c MicroserviceExampleCommand) GetHelpText() string

func (MicroserviceExampleCommand) Proceed

func (c MicroserviceExampleCommand) Proceed(subaction string, args []string) error

type MicroserviceExampleStartCommand

type MicroserviceExampleStartCommand struct {
}

func (MicroserviceExampleStartCommand) GetHelpText

func (command MicroserviceExampleStartCommand) GetHelpText() string

func (MicroserviceExampleStartCommand) Proceed

func (command MicroserviceExampleStartCommand) Proceed(subaction string, args []string) error

type MicroserviceExampleStartOptions

type MicroserviceExampleStartOptions struct {
	StartSwagger bool `long:"swagger" description:"Start swagger for your microservice"`
}

type MigrateCommand

type MigrateCommand struct {
}

func (MigrateCommand) GetHelpText

func (c MigrateCommand) GetHelpText() string

func (MigrateCommand) Proceed

func (c MigrateCommand) Proceed(subaction string, args []string) error

type Migration

type Migration struct {
	gorm.Model
	MigrationName string `gorm:"index:migration_migration_name,unique"`
	AppliedAt     time.Time
}

type OpenAPICommand

type OpenAPICommand struct {
}

func (OpenAPICommand) GetHelpText

func (c OpenAPICommand) GetHelpText() string

func (OpenAPICommand) Proceed

func (c OpenAPICommand) Proceed(subaction string, args []string) error

type ServeAdminServer

type ServeAdminServer struct {
}

func (ServeAdminServer) GetHelpText

func (command ServeAdminServer) GetHelpText() string

func (ServeAdminServer) Proceed

func (command ServeAdminServer) Proceed(subaction string, args []string) error

type ServeOpenAPIEditorCommand

type ServeOpenAPIEditorCommand struct {
}

func (ServeOpenAPIEditorCommand) GetHelpText

func (command ServeOpenAPIEditorCommand) GetHelpText() string

func (ServeOpenAPIEditorCommand) Proceed

func (command ServeOpenAPIEditorCommand) Proceed(subaction string, args []string) error

type ServeSwaggerServer

type ServeSwaggerServer struct {
}

func (ServeSwaggerServer) GetHelpText

func (command ServeSwaggerServer) GetHelpText() string

func (ServeSwaggerServer) Proceed

func (command ServeSwaggerServer) Proceed(subaction string, args []string) error

type ServeSwaggerServerOptions

type ServeSwaggerServerOptions struct {
}

type ShellCommand

type ShellCommand struct {
}

func (ShellCommand) GetHelpText

func (c ShellCommand) GetHelpText() string

func (ShellCommand) Proceed

func (c ShellCommand) Proceed(subaction string, args []string) error

type SuperadminCommand

type SuperadminCommand struct {
}

func (SuperadminCommand) GetHelpText

func (c SuperadminCommand) GetHelpText() string

func (SuperadminCommand) Proceed

func (c SuperadminCommand) Proceed(subaction string, args []string) error

type SuperadminCommandOptions

type SuperadminCommandOptions struct {
	Username  string `short:"n" required:"true" description:"Username" valid:"username-go-monolith,username-unique"`
	Email     string `short:"e" required:"true" description:"Email'" valid:"email,email-unique"`
	FirstName string `short:"f" required:"false" description:"First name'"`
	LastName  string `short:"l" required:"false" description:"Last name'"`
}

type SwaggerCommand

type SwaggerCommand struct {
}

func (SwaggerCommand) GetHelpText

func (c SwaggerCommand) GetHelpText() string

func (SwaggerCommand) Proceed

func (c SwaggerCommand) Proceed(subaction string, args []string) error

type SyncContentTypes

type SyncContentTypes struct {
}

func (SyncContentTypes) GetHelpText

func (command SyncContentTypes) GetHelpText() string

func (SyncContentTypes) Proceed

func (command SyncContentTypes) Proceed(subaction string, args []string) error

type TestSuite

type TestSuite struct {
	suite.Suite
	App      *App
	Database *core.ProjectDatabase
}

func (*TestSuite) SetupTest

func (suite *TestSuite) SetupTest()

func (*TestSuite) StoreDatabase

func (suite *TestSuite) StoreDatabase(database *core.ProjectDatabase)

func (*TestSuite) TearDownSuite

func (suite *TestSuite) TearDownSuite()

type UpMigration

type UpMigration struct {
}

func (UpMigration) GetHelpText

func (command UpMigration) GetHelpText() string

func (UpMigration) Proceed

func (command UpMigration) Proceed(subaction string, args []string) error

type UpMigrationOptions

type UpMigrationOptions struct {
}

type ValidationError

type ValidationError struct {
	Code    string
	Message string
	Params  []string
}

A ValidationError is an error that is used when the required input fails validation. swagger:response validationError

Jump to

Keyboard shortcuts

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