uadmin

package module
Version: v1.4.7 Latest Latest
Warning

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

Go to latest
Published: Nov 21, 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/uadmin/...

To test if your installation is fine, run the uadmin command line:

Get full documentation online: https://uadmindocs.sergeyg.me/


## Your First App

[Check it out here]https://uadmindocs.sergeyg.me/docs/intro

Documentation

Overview

Schemes: http, https
Host: localhost
BasePath: /v2
Version: 0.0.1
License: MIT http://opensource.org/licenses/MIT
Contact: John Doe<john.doe@example.com> http://john.doe.com

Consumes:
- application/json
- application/xml

Produces:
- application/json
- application/xml

Security:
- api_key:

SecurityDefinitions:
api_key:
     type: apiKey
     name: KEY
     in: header
oauth2:
    type: oauth2
    authorizationUrl: /oauth2/auth
    tokenUrl: /oauth2/token
    in: header
    scopes:
      bar: foo
    flow: accessCode

Extensions:
x-meta-value: value
x-meta-array:
  - value1
  - value2
x-meta-array-obj:
  - name: obj
    value: field

swagger:meta

Index

Constants

This section is empty.

Variables

View Source
var CreatedDatabaseForTests bool

Functions

func ClearApp added in v1.0.1

func ClearApp()

func ClearTestApp added in v1.0.1

func ClearTestApp()

func RunTests added in v1.1.2

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

func StoreCurrentApp added in v1.0.1

func StoreCurrentApp(app *App)

func TestHTTPResponse added in v1.0.1

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 added in v1.0.1

type AddLanguageHandler struct {
}

func (AddLanguageHandler) GetHelpText added in v1.0.1

func (command AddLanguageHandler) GetHelpText() string

func (AddLanguageHandler) Proceed added in v1.0.1

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

type AddLanguageHandlerOptions added in v1.0.1

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

type AdminCommand added in v1.0.1

type AdminCommand struct {
}

func (AdminCommand) GetHelpText added in v1.0.1

func (c AdminCommand) GetHelpText() string

func (AdminCommand) Proceed added in v1.0.1

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

type AdminStartServerOptions added in v1.0.1

type AdminStartServerOptions struct {
}

type App added in v1.0.1

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

func NewApp added in v1.0.1

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

func NewFullAppForTests added in v1.0.1

func NewFullAppForTests() *App

func (*App) BaseAPIUrl added in v1.0.1

func (a *App) BaseAPIUrl() string

func (*App) ExecuteCommand added in v1.0.1

func (a *App) ExecuteCommand()

func (*App) GetAuthAdapterRegistry added in v1.2.4

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

func (*App) GetBlueprintRegistry added in v1.1.7

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

func (*App) GetCommandRegistry added in v1.1.7

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

func (*App) GetConfig added in v1.1.7

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

func (*App) GetDashboardAdminPanel added in v1.1.7

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

func (*App) GetDatabase added in v1.1.7

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

func (*App) GetRouter added in v1.1.7

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

func (*App) Initialize added in v1.0.1

func (a *App) Initialize()

func (*App) InitializeRouter added in v1.0.1

func (a *App) InitializeRouter()

func (*App) RegisterBaseBlueprints added in v1.0.1

func (a *App) RegisterBaseBlueprints()

func (*App) RegisterBaseCommands added in v1.0.1

func (a *App) RegisterBaseCommands()

func (*App) RegisterBlueprint added in v1.0.1

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

func (*App) RegisterCommand added in v1.0.1

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

func (*App) StartAPI added in v1.0.1

func (a *App) StartAPI()

func (*App) StartAdmin added in v1.0.1

func (a *App) StartAdmin()

func (*App) TriggerCommandExecution added in v1.0.1

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

type BlueprintCommand added in v1.0.1

type BlueprintCommand struct {
}

func (BlueprintCommand) GetHelpText added in v1.0.1

func (c BlueprintCommand) GetHelpText() string

func (BlueprintCommand) Proceed added in v1.0.1

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

type ContentTypeCommand added in v1.0.1

type ContentTypeCommand struct {
}

func (ContentTypeCommand) GetHelpText added in v1.0.1

func (c ContentTypeCommand) GetHelpText() string

func (ContentTypeCommand) Proceed added in v1.0.1

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

type CreateBlueprint added in v1.0.1

type CreateBlueprint struct {
}

func (CreateBlueprint) GetHelpText added in v1.0.1

func (command CreateBlueprint) GetHelpText() string

func (CreateBlueprint) Proceed added in v1.0.1

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

type CreateBlueprintOptions added in v1.0.1

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 added in v1.0.1

type CreateFakedDataCommand struct {
}

func (CreateFakedDataCommand) GetHelpText added in v1.0.1

func (c CreateFakedDataCommand) GetHelpText() string

func (CreateFakedDataCommand) Proceed added in v1.0.1

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

type CreateMigration added in v1.0.1

type CreateMigration struct {
}

func (CreateMigration) GetHelpText added in v1.0.1

func (command CreateMigration) GetHelpText() string

func (CreateMigration) Proceed added in v1.0.1

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

type CreateMigrationOptions added in v1.0.1

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 added in v1.0.1

type CreateSuperadmin struct {
}

func (CreateSuperadmin) GetHelpText added in v1.0.1

func (command CreateSuperadmin) GetHelpText() string

func (CreateSuperadmin) Proceed added in v1.0.1

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

type DbShellCommand added in v1.1.2

type DbShellCommand struct {
}

func (DbShellCommand) GetHelpText added in v1.1.2

func (c DbShellCommand) GetHelpText() string

func (DbShellCommand) Proceed added in v1.1.2

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

type DetermineConflictsMigration added in v1.0.1

type DetermineConflictsMigration struct {
}

func (DetermineConflictsMigration) GetHelpText added in v1.0.1

func (command DetermineConflictsMigration) GetHelpText() string

func (DetermineConflictsMigration) Proceed added in v1.0.1

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

type DownMigration added in v1.0.1

type DownMigration struct {
}

func (DownMigration) GetHelpText added in v1.0.1

func (command DownMigration) GetHelpText() string

func (DownMigration) Proceed added in v1.0.1

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

type DownMigrationOptions added in v1.0.1

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

type GeneralError added in v1.2.5

type GeneralError struct {
	Error string
}

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

type LanguageCommand added in v1.0.1

type LanguageCommand struct {
}

func (LanguageCommand) GetHelpText added in v1.0.1

func (c LanguageCommand) GetHelpText() string

func (LanguageCommand) Proceed added in v1.0.1

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

type MicroserviceExample added in v1.2.4

type MicroserviceExample struct {
	core.Microservice
}

type MicroserviceExampleCommand added in v1.2.4

type MicroserviceExampleCommand struct {
}

func (MicroserviceExampleCommand) GetHelpText added in v1.2.4

func (c MicroserviceExampleCommand) GetHelpText() string

func (MicroserviceExampleCommand) Proceed added in v1.2.4

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

type MicroserviceExampleStartCommand added in v1.2.4

type MicroserviceExampleStartCommand struct {
}

func (MicroserviceExampleStartCommand) GetHelpText added in v1.2.4

func (command MicroserviceExampleStartCommand) GetHelpText() string

func (MicroserviceExampleStartCommand) Proceed added in v1.2.4

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

type MicroserviceExampleStartOptions added in v1.2.4

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

type MigrateCommand added in v1.0.1

type MigrateCommand struct {
}

func (MigrateCommand) GetHelpText added in v1.0.1

func (c MigrateCommand) GetHelpText() string

func (MigrateCommand) Proceed added in v1.0.1

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

type Migration added in v1.0.1

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

type OpenAPICommand added in v1.0.1

type OpenAPICommand struct {
}

func (OpenAPICommand) GetHelpText added in v1.0.1

func (c OpenAPICommand) GetHelpText() string

func (OpenAPICommand) Proceed added in v1.0.1

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

type ServeAdminServer added in v1.0.1

type ServeAdminServer struct {
}

func (ServeAdminServer) GetHelpText added in v1.0.1

func (command ServeAdminServer) GetHelpText() string

func (ServeAdminServer) Proceed added in v1.0.1

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

type ServeOpenAPIEditorCommand added in v1.0.1

type ServeOpenAPIEditorCommand struct {
}

func (ServeOpenAPIEditorCommand) GetHelpText added in v1.0.1

func (command ServeOpenAPIEditorCommand) GetHelpText() string

func (ServeOpenAPIEditorCommand) Proceed added in v1.0.1

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

type ServeSwaggerServer added in v1.0.1

type ServeSwaggerServer struct {
}

func (ServeSwaggerServer) GetHelpText added in v1.0.1

func (command ServeSwaggerServer) GetHelpText() string

func (ServeSwaggerServer) Proceed added in v1.0.1

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

type ServeSwaggerServerOptions added in v1.0.1

type ServeSwaggerServerOptions struct {
}

type ShellCommand added in v1.1.2

type ShellCommand struct {
}

func (ShellCommand) GetHelpText added in v1.1.2

func (c ShellCommand) GetHelpText() string

func (ShellCommand) Proceed added in v1.1.2

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

type SuperadminCommand added in v1.0.1

type SuperadminCommand struct {
}

func (SuperadminCommand) GetHelpText added in v1.0.1

func (c SuperadminCommand) GetHelpText() string

func (SuperadminCommand) Proceed added in v1.0.1

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

type SuperadminCommandOptions added in v1.0.1

type SuperadminCommandOptions struct {
	Username  string `short:"n" required:"true" description:"Username" valid:"username-uadmin,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 added in v1.0.1

type SwaggerCommand struct {
}

func (SwaggerCommand) GetHelpText added in v1.0.1

func (c SwaggerCommand) GetHelpText() string

func (SwaggerCommand) Proceed added in v1.0.1

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

type SyncContentTypes added in v1.0.1

type SyncContentTypes struct {
}

func (SyncContentTypes) GetHelpText added in v1.0.1

func (command SyncContentTypes) GetHelpText() string

func (SyncContentTypes) Proceed added in v1.0.1

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

type TestSuite added in v1.0.1

type TestSuite struct {
	suite.Suite
	App            *App
	UadminDatabase *core.UadminDatabase
}

func (*TestSuite) SetupTest added in v1.0.1

func (suite *TestSuite) SetupTest()

func (*TestSuite) StoreDatabase added in v1.1.2

func (suite *TestSuite) StoreDatabase(uadminDatabase *core.UadminDatabase)

func (*TestSuite) TearDownSuite added in v1.0.1

func (suite *TestSuite) TearDownSuite()

type UpMigration added in v1.0.1

type UpMigration struct {
}

func (UpMigration) GetHelpText added in v1.0.1

func (command UpMigration) GetHelpText() string

func (UpMigration) Proceed added in v1.0.1

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

type UpMigrationOptions added in v1.0.1

type UpMigrationOptions struct {
}

type ValidationError added in v1.2.4

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